SEARCH api/v1/sites?country={country}&state={state}&eligibilityId={eligibilityId}&properties={properties}&orderBy={orderBy}&take={take}&skip={skip}

Request Information

URI Parameters

Name	Type	Additional information
SiteId	string	None.
Radius	integer	None.
StartDate	string	None.
SlotNumber	integer	None.
EndDate	string	None.
Start	date	None.
End	date	None.
ExamId	Collection of string	None.
EligibilityId	string	None.
country	string	Required
state	string	Required
eligibilityId	string	None.
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0

Body Parameters

Collection of TestingAccommodationBindingModel

Name	Type	Additional information
Id	string	None.
Href	string	None.
Name	string	None.
Attributes	Collection of AttributeBindingModel	None.
CategoryId	integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "Href": "sample string 2",
    "Name": "sample string 3",
    "Attributes": [
      {
        "Name": "sample string 1",
        "Parameters": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Parameters": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      }
    ],
    "CategoryId": 4
  },
  {
    "Id": "sample string 1",
    "Href": "sample string 2",
    "Name": "sample string 3",
    "Attributes": [
      {
        "Name": "sample string 1",
        "Parameters": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      },
      {
        "Name": "sample string 1",
        "Parameters": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      }
    ],
    "CategoryId": 4
  }
]

application/xml, text/xml

Sample:

<ArrayOfTestingAccommodationBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.TestingAccommodation">
  <TestingAccommodationBindingModel>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
      <AttributeBindingModel>
        <Name>sample string 1</Name>
        <Parameters>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
        </Parameters>
      </AttributeBindingModel>
      <AttributeBindingModel>
        <Name>sample string 1</Name>
        <Parameters>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
        </Parameters>
      </AttributeBindingModel>
    </Attributes>
    <CategoryId xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
    <Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
  </TestingAccommodationBindingModel>
  <TestingAccommodationBindingModel>
    <Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
      <AttributeBindingModel>
        <Name>sample string 1</Name>
        <Parameters>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
        </Parameters>
      </AttributeBindingModel>
      <AttributeBindingModel>
        <Name>sample string 1</Name>
        <Parameters>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
          <ParameterBindingModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </ParameterBindingModel>
        </Parameters>
      </AttributeBindingModel>
    </Attributes>
    <CategoryId xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
    <Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
    <Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
  </TestingAccommodationBindingModel>
</ArrayOfTestingAccommodationBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IEnumerable`1'.

Response Information

Resource Description

ResponseWrapperBindingModelOfIEnumerableOfSiteBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    {
      "Href": "sample string 1",
      "Location": {
        "TimeZone": "sample string 1",
        "TimeZoneOffset": "sample string 2",
        "Coordinates": [
          1.1,
          2.1
        ],
        "Directions": [
          {
            "Name": "sample string 1",
            "GeneralMemo": "sample string 2",
            "SchedulingMemo": "sample string 3",
            "Direction": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "GeneralMemo": "sample string 2",
            "SchedulingMemo": "sample string 3",
            "Direction": "sample string 4"
          }
        ],
        "Distance": 3.1,
        "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"
        }
      },
      "Id": "sample string 2",
      "Type": "sample string 3",
      "Prefix": "sample string 4",
      "ManagementTypeId": 5
    },
    {
      "Href": "sample string 1",
      "Location": {
        "TimeZone": "sample string 1",
        "TimeZoneOffset": "sample string 2",
        "Coordinates": [
          1.1,
          2.1
        ],
        "Directions": [
          {
            "Name": "sample string 1",
            "GeneralMemo": "sample string 2",
            "SchedulingMemo": "sample string 3",
            "Direction": "sample string 4"
          },
          {
            "Name": "sample string 1",
            "GeneralMemo": "sample string 2",
            "SchedulingMemo": "sample string 3",
            "Direction": "sample string 4"
          }
        ],
        "Distance": 3.1,
        "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"
        }
      },
      "Id": "sample string 2",
      "Type": "sample string 3",
      "Prefix": "sample string 4",
      "ManagementTypeId": 5
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfSiteBindingModelPu7yIHrR 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.Site">
    <d2p1:SiteBindingModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
      <ManagementTypeId xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">5</ManagementTypeId>
      <Prefix xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</Prefix>
      <Type xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Type>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Location>
        <Address xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <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>
          </AddressLine>
          <AdminDistrict>sample string 2</AdminDistrict>
          <Country>sample string 4</Country>
          <FormattedAddress>sample string 5</FormattedAddress>
          <Locality>sample string 1</Locality>
          <PostalCode>sample string 3</PostalCode>
        </Address>
        <Contact xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <FaxNumber>sample string 2</FaxNumber>
          <PhoneNumber>sample string 1</PhoneNumber>
        </Contact>
        <d2p1:Coordinates xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:double>1.1</d5p1:double>
          <d5p1:double>2.1</d5p1:double>
        </d2p1:Coordinates>
        <d2p1:Directions>
          <d2p1:DirectionBindingModel>
            <d2p1:Direction>sample string 4</d2p1:Direction>
            <d2p1:GeneralMemo>sample string 2</d2p1:GeneralMemo>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:SchedulingMemo>sample string 3</d2p1:SchedulingMemo>
          </d2p1:DirectionBindingModel>
          <d2p1:DirectionBindingModel>
            <d2p1:Direction>sample string 4</d2p1:Direction>
            <d2p1:GeneralMemo>sample string 2</d2p1:GeneralMemo>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:SchedulingMemo>sample string 3</d2p1:SchedulingMemo>
          </d2p1:DirectionBindingModel>
        </d2p1:Directions>
        <d2p1:Distance>3.1</d2p1:Distance>
        <d2p1:TimeZone>sample string 1</d2p1:TimeZone>
        <d2p1:TimeZoneOffset>sample string 2</d2p1:TimeZoneOffset>
      </d2p1:Location>
    </d2p1:SiteBindingModel>
    <d2p1:SiteBindingModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Id>
      <ManagementTypeId xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">5</ManagementTypeId>
      <Prefix xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</Prefix>
      <Type xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Type>
      <d2p1:Href>sample string 1</d2p1:Href>
      <d2p1:Location>
        <Address xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <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>
          </AddressLine>
          <AdminDistrict>sample string 2</AdminDistrict>
          <Country>sample string 4</Country>
          <FormattedAddress>sample string 5</FormattedAddress>
          <Locality>sample string 1</Locality>
          <PostalCode>sample string 3</PostalCode>
        </Address>
        <Contact xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
          <FaxNumber>sample string 2</FaxNumber>
          <PhoneNumber>sample string 1</PhoneNumber>
        </Contact>
        <d2p1:Coordinates xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:double>1.1</d5p1:double>
          <d5p1:double>2.1</d5p1:double>
        </d2p1:Coordinates>
        <d2p1:Directions>
          <d2p1:DirectionBindingModel>
            <d2p1:Direction>sample string 4</d2p1:Direction>
            <d2p1:GeneralMemo>sample string 2</d2p1:GeneralMemo>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:SchedulingMemo>sample string 3</d2p1:SchedulingMemo>
          </d2p1:DirectionBindingModel>
          <d2p1:DirectionBindingModel>
            <d2p1:Direction>sample string 4</d2p1:Direction>
            <d2p1:GeneralMemo>sample string 2</d2p1:GeneralMemo>
            <d2p1:Name>sample string 1</d2p1:Name>
            <d2p1:SchedulingMemo>sample string 3</d2p1:SchedulingMemo>
          </d2p1:DirectionBindingModel>
        </d2p1:Directions>
        <d2p1:Distance>3.1</d2p1:Distance>
        <d2p1:TimeZone>sample string 1</d2p1:TimeZone>
        <d2p1:TimeZoneOffset>sample string 2</d2p1:TimeZoneOffset>
      </d2p1:Location>
    </d2p1:SiteBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfSiteBindingModelPu7yIHrR>