POST MyPortal/GetPracticeDetails

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.PracticeDetailsRequest

Name	Type	Additional information
AppKey	globally unique identifier	None.
CustomerId	integer	None.
PracticeId	integer	None.
CustomerPracticeId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "AppKey": "1da625d7-f6f4-4a17-9ff1-8dead3c61f9c",
  "CustomerId": 2,
  "PracticeId": 1,
  "CustomerPracticeId": "sample string 3"
}

application/xml, text/xml

Sample:

<PracticeDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>1da625d7-f6f4-4a17-9ff1-8dead3c61f9c</AppKey>
  <CustomerId>2</CustomerId>
  <CustomerPracticeId>sample string 3</CustomerPracticeId>
  <PracticeId>1</PracticeId>
</PracticeDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.PracticeDetailsResponse

Name	Type	Additional information
DefaultSource	string	None.
PracticeName	string	None.
PracticePhone	string	None.
PracticeEmail	string	None.
PracticeMapUrl	string	None.
PracticeLogoUrl	string	None.
PracticeCheckInMessage	string	None.
PracticeCheckInBeforeMins	integer	None.
PracticeCheckInAfterMins	integer	None.
PracticeId	integer	None.
CustomerPracticeId	string	None.
PrivacyStatement	string	None.
PracticeAddress	string	None.
NhsProviderName	string	None.
NhsLocationNumber	string	None.
Features	Collection of integer	None.
ApiKey	string	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.
HasError	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "DefaultSource": "sample string 1",
  "PracticeName": "sample string 2",
  "PracticePhone": "sample string 3",
  "PracticeEmail": "sample string 4",
  "PracticeMapUrl": "sample string 5",
  "PracticeLogoUrl": "sample string 6",
  "PracticeCheckInMessage": "sample string 7",
  "PracticeCheckInBeforeMins": 1,
  "PracticeCheckInAfterMins": 1,
  "PracticeId": 8,
  "CustomerPracticeId": "sample string 9",
  "PrivacyStatement": "sample string 10",
  "PracticeAddress": "sample string 11",
  "NhsProviderName": "sample string 12",
  "NhsLocationNumber": "sample string 13",
  "Features": [
    1,
    2
  ],
  "ApiKey": "sample string 14",
  "ErrorMessage": "sample string 15",
  "ErrorStackTrace": "sample string 16",
  "HasError": true
}

application/xml, text/xml

Sample:

<PracticeDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ApiKey>sample string 14</ApiKey>
  <ErrorMessage>sample string 15</ErrorMessage>
  <ErrorStackTrace>sample string 16</ErrorStackTrace>
  <CustomerPracticeId>sample string 9</CustomerPracticeId>
  <DefaultSource>sample string 1</DefaultSource>
  <Features xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Features>
  <NhsLocationNumber>sample string 13</NhsLocationNumber>
  <NhsProviderName>sample string 12</NhsProviderName>
  <PracticeAddress>sample string 11</PracticeAddress>
  <PracticeCheckInAfterMins>1</PracticeCheckInAfterMins>
  <PracticeCheckInBeforeMins>1</PracticeCheckInBeforeMins>
  <PracticeCheckInMessage>sample string 7</PracticeCheckInMessage>
  <PracticeEmail>sample string 4</PracticeEmail>
  <PracticeId>8</PracticeId>
  <PracticeLogoUrl>sample string 6</PracticeLogoUrl>
  <PracticeMapUrl>sample string 5</PracticeMapUrl>
  <PracticeName>sample string 2</PracticeName>
  <PracticePhone>sample string 3</PracticePhone>
  <PrivacyStatement>sample string 10</PrivacyStatement>
</PracticeDetailsResponse>