POST Public/SetPracticeCredits

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.DTOs.Request.SetPracticeCreditsRequest

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

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "b4ccb825-069f-4dfa-985c-e984d5cf409a",
  "Username": "sample string 2",
  "CustomerSiteId": "sample string 3",
  "CreditBalance": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Public.DTOs.Response.GetPracticeCreditsResponse

Name	Type	Additional information
Success	boolean	None.
Errors	Dictionary of string [key] and string [value]	None.
CustomerSiteId	string	None.
CreditBalance	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "CustomerSiteId": "sample string 2",
  "CreditBalance": 1
}

application/xml, text/xml

Sample:

<GetPracticeCreditsResponse 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>
  <Success xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">true</Success>
  <CreditBalance>1</CreditBalance>
  <CustomerSiteId>sample string 2</CustomerSiteId>
</GetPracticeCreditsResponse>