POST MyPortal/GetPracticeDetailsEx

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": "8167b509-aa40-4bf3-a3ac-563f07857c4c",
  "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>8167b509-aa40-4bf3-a3ac-563f07857c4c</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.CustomerPracticeIdPracticeDetailsResponse

Name	Type	Additional information
CustomerId	integer	None.
CustomerPracticeId	string	None.
PracticeDetails	Collection of PatientComms.API.Models.CustomerPracticeDetail	None.
ApiKey	string	None.
ErrorMessage	string	None.
ErrorStackTrace	string	None.
HasError	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CustomerPracticeId": "sample string 2",
  "PracticeDetails": [
    {
      "PracticeId": 1,
      "PracticeName": "sample string 2"
    },
    {
      "PracticeId": 1,
      "PracticeName": "sample string 2"
    }
  ],
  "ApiKey": "sample string 3",
  "ErrorMessage": "sample string 4",
  "ErrorStackTrace": "sample string 5",
  "HasError": true
}

application/xml, text/xml

Sample:

<CustomerPracticeIdPracticeDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Models">
  <ApiKey>sample string 3</ApiKey>
  <ErrorMessage>sample string 4</ErrorMessage>
  <ErrorStackTrace>sample string 5</ErrorStackTrace>
  <CustomerId>1</CustomerId>
  <CustomerPracticeId>sample string 2</CustomerPracticeId>
  <PracticeDetails>
    <CustomerPracticeDetail>
      <PracticeId>1</PracticeId>
      <PracticeName>sample string 2</PracticeName>
    </CustomerPracticeDetail>
    <CustomerPracticeDetail>
      <PracticeId>1</PracticeId>
      <PracticeName>sample string 2</PracticeName>
    </CustomerPracticeDetail>
  </PracticeDetails>
</CustomerPracticeIdPracticeDetailsResponse>