POST PatientPortal/PracticeDetails

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.PracticeDetailRequest

Name	Description	Type	Additional information
PracticeIds		Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PracticeIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<PracticeDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <PracticeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PracticeIds>
</PracticeDetailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.PracticeDetailResponse

Name	Type	Additional information
Successful	boolean	None.
ErrorMessage	string	None.
PracticeDetails	Collection of PatientComms.API.Models.PracticeDto	None.
PracticeIds	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Successful": true,
  "ErrorMessage": "sample string 2",
  "PracticeDetails": [
    {
      "PracticeId": 1,
      "CustomerPracticeId": "sample string 2",
      "PracticeIdentity": "3c43e25e-7c69-4206-aa41-64421ebc96f0",
      "PracticeName": "sample string 4",
      "ContactAddress": "sample string 5",
      "ContactPhone": "sample string 6",
      "ContactEmail": "sample string 7",
      "WebsiteUrl": "sample string 8",
      "LogoUrl": "sample string 9",
      "IsActive": true,
      "SquareLogoUrl": "sample string 11",
      "PrimaryColour": "sample string 12",
      "AccentColour": "sample string 13",
      "WarnColour": "sample string 14",
      "CallUsText": "sample string 15",
      "CallUsButtonText": "sample string 16",
      "CallUsPhoneNumber": "sample string 17"
    },
    {
      "PracticeId": 1,
      "CustomerPracticeId": "sample string 2",
      "PracticeIdentity": "3c43e25e-7c69-4206-aa41-64421ebc96f0",
      "PracticeName": "sample string 4",
      "ContactAddress": "sample string 5",
      "ContactPhone": "sample string 6",
      "ContactEmail": "sample string 7",
      "WebsiteUrl": "sample string 8",
      "LogoUrl": "sample string 9",
      "IsActive": true,
      "SquareLogoUrl": "sample string 11",
      "PrimaryColour": "sample string 12",
      "AccentColour": "sample string 13",
      "WarnColour": "sample string 14",
      "CallUsText": "sample string 15",
      "CallUsButtonText": "sample string 16",
      "CallUsPhoneNumber": "sample string 17"
    }
  ],
  "PracticeIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<PracticeDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <PracticeDetails>
    <PracticeDto>
      <AccentColour>sample string 13</AccentColour>
      <CallUsButtonText>sample string 16</CallUsButtonText>
      <CallUsPhoneNumber>sample string 17</CallUsPhoneNumber>
      <CallUsText>sample string 15</CallUsText>
      <ContactAddress>sample string 5</ContactAddress>
      <ContactEmail>sample string 7</ContactEmail>
      <ContactPhone>sample string 6</ContactPhone>
      <CustomerPracticeId>sample string 2</CustomerPracticeId>
      <IsActive>true</IsActive>
      <LogoUrl>sample string 9</LogoUrl>
      <PracticeId>1</PracticeId>
      <PracticeIdentity>3c43e25e-7c69-4206-aa41-64421ebc96f0</PracticeIdentity>
      <PracticeName>sample string 4</PracticeName>
      <PrimaryColour>sample string 12</PrimaryColour>
      <SquareLogoUrl>sample string 11</SquareLogoUrl>
      <WarnColour>sample string 14</WarnColour>
      <WebsiteUrl>sample string 8</WebsiteUrl>
    </PracticeDto>
    <PracticeDto>
      <AccentColour>sample string 13</AccentColour>
      <CallUsButtonText>sample string 16</CallUsButtonText>
      <CallUsPhoneNumber>sample string 17</CallUsPhoneNumber>
      <CallUsText>sample string 15</CallUsText>
      <ContactAddress>sample string 5</ContactAddress>
      <ContactEmail>sample string 7</ContactEmail>
      <ContactPhone>sample string 6</ContactPhone>
      <CustomerPracticeId>sample string 2</CustomerPracticeId>
      <IsActive>true</IsActive>
      <LogoUrl>sample string 9</LogoUrl>
      <PracticeId>1</PracticeId>
      <PracticeIdentity>3c43e25e-7c69-4206-aa41-64421ebc96f0</PracticeIdentity>
      <PracticeName>sample string 4</PracticeName>
      <PrimaryColour>sample string 12</PrimaryColour>
      <SquareLogoUrl>sample string 11</SquareLogoUrl>
      <WarnColour>sample string 14</WarnColour>
      <WebsiteUrl>sample string 8</WebsiteUrl>
    </PracticeDto>
  </PracticeDetails>
  <PracticeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PracticeIds>
  <Successful>true</Successful>
</PracticeDetailResponse>