GET api/v1/clients/{id}?isPublished={isPublished}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

isPublished

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ClientBindingModel
NameDescriptionTypeAdditional information
Id

string

None.

Href

string

None.

Code

string

None.

Sso

boolean

None.

Name

string

None.

Location

LocationBindingModel

None.

Schedule

ScheduleBindingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Href": "sample string 3",
  "Code": "sample string 4",
  "Sso": true,
  "Name": "sample string 6",
  "Location": {
    "Address": {
      "AddressLine": [
        "sample string 1",
        "sample string 2"
      ],
      "Locality": "sample string 1",
      "AdminDistrict": "sample string 2",
      "PostalCode": "sample string 3",
      "Country": "sample string 4",
      "FormattedAddress": "sample string 5"
    },
    "Contact": {
      "PhoneNumber": "sample string 1",
      "FaxNumber": "sample string 2"
    }
  },
  "Schedule": {
    "StartDate": "2024-12-03T11:41:19.6148828-05:00",
    "EndDate": "2024-12-03T11:41:19.6148828-05:00"
  }
}

application/xml, text/xml

Sample:
<ClientBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Client">
  <Code>sample string 4</Code>
  <Href>sample string 3</Href>
  <Id>sample string 1</Id>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
    <d2p1:Address>
      <d2p1:AddressLine xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:AddressLine>
      <d2p1:AdminDistrict>sample string 2</d2p1:AdminDistrict>
      <d2p1:Country>sample string 4</d2p1:Country>
      <d2p1:FormattedAddress>sample string 5</d2p1:FormattedAddress>
      <d2p1:Locality>sample string 1</d2p1:Locality>
      <d2p1:PostalCode>sample string 3</d2p1:PostalCode>
    </d2p1:Address>
    <d2p1:Contact>
      <d2p1:FaxNumber>sample string 2</d2p1:FaxNumber>
      <d2p1:PhoneNumber>sample string 1</d2p1:PhoneNumber>
    </d2p1:Contact>
  </Location>
  <Name>sample string 6</Name>
  <Schedule>
    <EndDate>2024-12-03T11:41:19.6148828-05:00</EndDate>
    <StartDate>2024-12-03T11:41:19.6148828-05:00</StartDate>
  </Schedule>
  <Sso>true</Sso>
  <Uri>sample string 2</Uri>
</ClientBindingModel>