GET api/v1/clients?code={code}&isPublished={isPublished}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

Name	Type	Additional information
code	string	None.
isPublished	boolean	Default value is False
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfClientBindingModel

Name	Description	Type	Additional information
Results		Collection of ClientBindingModel	None.
TotalResults		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "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": "2025-04-04T01:29:51.2945043-04:00",
        "EndDate": "2025-04-04T01:29:51.2945043-04:00"
      }
    },
    {
      "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": "2025-04-04T01:29:51.2945043-04:00",
        "EndDate": "2025-04-04T01:29:51.2945043-04:00"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfClientBindingModelJ20fpKGp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
  <TotalResults>1</TotalResults>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Client">
    <d2p1:ClientBindingModel>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Href>sample string 3</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Address>
          <d4p1:AddressLine xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:AddressLine>
          <d4p1:AdminDistrict>sample string 2</d4p1:AdminDistrict>
          <d4p1:Country>sample string 4</d4p1:Country>
          <d4p1:FormattedAddress>sample string 5</d4p1:FormattedAddress>
          <d4p1:Locality>sample string 1</d4p1:Locality>
          <d4p1:PostalCode>sample string 3</d4p1:PostalCode>
        </d4p1:Address>
        <d4p1:Contact>
          <d4p1:FaxNumber>sample string 2</d4p1:FaxNumber>
          <d4p1:PhoneNumber>sample string 1</d4p1:PhoneNumber>
        </d4p1:Contact>
      </d2p1:Location>
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:Schedule>
        <d2p1:EndDate>2025-04-04T01:29:51.2945043-04:00</d2p1:EndDate>
        <d2p1:StartDate>2025-04-04T01:29:51.2945043-04:00</d2p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Sso>true</d2p1:Sso>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ClientBindingModel>
    <d2p1:ClientBindingModel>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Href>sample string 3</d2p1:Href>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
        <d4p1:Address>
          <d4p1:AddressLine xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d4p1:AddressLine>
          <d4p1:AdminDistrict>sample string 2</d4p1:AdminDistrict>
          <d4p1:Country>sample string 4</d4p1:Country>
          <d4p1:FormattedAddress>sample string 5</d4p1:FormattedAddress>
          <d4p1:Locality>sample string 1</d4p1:Locality>
          <d4p1:PostalCode>sample string 3</d4p1:PostalCode>
        </d4p1:Address>
        <d4p1:Contact>
          <d4p1:FaxNumber>sample string 2</d4p1:FaxNumber>
          <d4p1:PhoneNumber>sample string 1</d4p1:PhoneNumber>
        </d4p1:Contact>
      </d2p1:Location>
      <d2p1:Name>sample string 6</d2p1:Name>
      <d2p1:Schedule>
        <d2p1:EndDate>2025-04-04T01:29:51.2945043-04:00</d2p1:EndDate>
        <d2p1:StartDate>2025-04-04T01:29:51.2945043-04:00</d2p1:StartDate>
      </d2p1:Schedule>
      <d2p1:Sso>true</d2p1:Sso>
      <d2p1:Uri>sample string 2</d2p1:Uri>
    </d2p1:ClientBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfClientBindingModelJ20fpKGp>