SEARCH api/v1/sites/availabilities?country={country}&state={state}&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
properties	string	None.
orderBy	string	None.
take	integer	Default value is 0
skip	integer	Default value is 0

Body Parameters

Collection of ExamsRequestBindingModel

Name	Description	Type	Additional information
Id		string	None.
TestingAccommodations		Collection of TestingAccommodationBindingModel	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "TestingAccommodations": [
      {
        "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
      }
    ]
  },
  {
    "Id": "sample string 1",
    "TestingAccommodations": [
      {
        "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:

<ArrayOfExamsRequestBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
  <ExamsRequestBindingModel>
    <Id>sample string 1</Id>
    <TestingAccommodations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.TestingAccommodation">
      <d3p1:TestingAccommodationBindingModel>
        <Attributes>
          <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>4</CategoryId>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </d3p1:TestingAccommodationBindingModel>
      <d3p1:TestingAccommodationBindingModel>
        <Attributes>
          <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>4</CategoryId>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </d3p1:TestingAccommodationBindingModel>
    </TestingAccommodations>
  </ExamsRequestBindingModel>
  <ExamsRequestBindingModel>
    <Id>sample string 1</Id>
    <TestingAccommodations xmlns:d3p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.TestingAccommodation">
      <d3p1:TestingAccommodationBindingModel>
        <Attributes>
          <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>4</CategoryId>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </d3p1:TestingAccommodationBindingModel>
      <d3p1:TestingAccommodationBindingModel>
        <Attributes>
          <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>4</CategoryId>
        <Href>sample string 2</Href>
        <Id>sample string 1</Id>
        <Name>sample string 3</Name>
      </d3p1:TestingAccommodationBindingModel>
    </TestingAccommodations>
  </ExamsRequestBindingModel>
</ArrayOfExamsRequestBindingModel>

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

ResponseWrapperBindingModelOfIEnumerableOfSiteAvailabilityBindingModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalResults": 1,
  "Results": [
    null,
    {
      "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"
        }
      },
      "Availability": null,
      "Id": null,
      "Type": null,
      "Prefix": null,
      "ManagementTypeId": 0
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseWrapperBindingModelOfArrayOfSiteAvailabilityBindingModelPu7yIHrR 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:SiteAvailabilityBindingModel i:nil="true" />
    <d2p1:SiteAvailabilityBindingModel>
      <Id i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models" />
      <ManagementTypeId xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">0</ManagementTypeId>
      <Prefix i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models" />
      <Type i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models" />
      <d2p1:Availability xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <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:SiteAvailabilityBindingModel>
  </Results>
</ResponseWrapperBindingModelOfArrayOfSiteAvailabilityBindingModelPu7yIHrR>