POST Public/GetPracticeDetails

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.DTOs.Request.GetPracticeDetailsRequest

Name	Type	Additional information
APIKey	globally unique identifier	Required
Username	string	Required
CustomerSiteId	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "084d7b99-a07d-420a-b297-c6a7e7161756",
  "Username": "sample string 2",
  "CustomerSiteId": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Public.DTOs.Response.GetPracticeDetailsResponse

Name	Type	Additional information
StatusId	integer	None.
Status	string	None.
Success	boolean	None.
Errors	Dictionary of string [key] and string [value]	None.
PracticeData	PatientComms.API.Public.DTOs.Response.PracticeData	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusId": 1,
  "Status": "sample string 2",
  "Success": true,
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "PracticeData": {
    "PracticeId": 1,
    "CustomerPracticeId": "sample string 2",
    "ShortName": "sample string 3",
    "Address1": "sample string 4",
    "Address2": "sample string 5",
    "Town": "sample string 6",
    "County": "sample string 7",
    "Country": "sample string 8",
    "Postcode": "sample string 9",
    "EmailAddress": "sample string 10",
    "Telephone": "sample string 11",
    "AppReminderDays": 1,
    "DefaultAppMsg": "sample string 12",
    "DefaultDentRecallMsg": "sample string 13",
    "DefaultHygnRecallMsg": "sample string 14",
    "Deleted": "2025-04-03T14:54:10.7187701+01:00"
  }
}

application/xml, text/xml

Sample:

<GetPracticeDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">sample string 2</Status>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">1</StatusId>
  <Success xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">true</Success>
  <PracticeData>
    <Address1>sample string 4</Address1>
    <Address2>sample string 5</Address2>
    <AppReminderDays>1</AppReminderDays>
    <Country>sample string 8</Country>
    <County>sample string 7</County>
    <CustomerPracticeId>sample string 2</CustomerPracticeId>
    <DefaultAppMsg>sample string 12</DefaultAppMsg>
    <DefaultDentRecallMsg>sample string 13</DefaultDentRecallMsg>
    <DefaultHygnRecallMsg>sample string 14</DefaultHygnRecallMsg>
    <Deleted>2025-04-03T14:54:10.7187701+01:00</Deleted>
    <EmailAddress>sample string 10</EmailAddress>
    <Postcode>sample string 9</Postcode>
    <PracticeId>1</PracticeId>
    <ShortName>sample string 3</ShortName>
    <Telephone>sample string 11</Telephone>
    <Town>sample string 6</Town>
  </PracticeData>
</GetPracticeDetailsResponse>