POST MyPortal/GetPracticeList

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Models.PracticeListRequest

Name	Description	Type	Additional information
AppKey		globally unique identifier	None.
CustomerId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AppKey": "ae20bcd4-1f52-4f7c-ba0b-eb08d781166f",
  "CustomerId": 2
}

application/xml, text/xml

Sample:

<PracticeListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <AppKey>ae20bcd4-1f52-4f7c-ba0b-eb08d781166f</AppKey>
  <CustomerId>2</CustomerId>
</PracticeListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Models.PracticeListResponse

Name	Type	Additional information
PracticeList	Collection of PatientComms.API.Models.PracticeListItem	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PracticeList": [
    {
      "PracticeId": 1,
      "PracticeName": "sample string 2"
    },
    {
      "PracticeId": 1,
      "PracticeName": "sample string 2"
    }
  ],
  "ErrorMessage": "sample string 1",
  "ErrorStackTrace": "sample string 2"
}

application/xml, text/xml

Sample:

<PracticeListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ErrorMessage>sample string 1</ErrorMessage>
  <ErrorStackTrace>sample string 2</ErrorStackTrace>
  <PracticeList>
    <PracticeListItem>
      <PracticeId>1</PracticeId>
      <PracticeName>sample string 2</PracticeName>
    </PracticeListItem>
    <PracticeListItem>
      <PracticeId>1</PracticeId>
      <PracticeName>sample string 2</PracticeName>
    </PracticeListItem>
  </PracticeList>
</PracticeListResponse>