SEARCH api/v1/slots?scheduleMethod={scheduleMethod}&numberOfSlots={numberOfSlots}&properties={properties}&orderBy={orderBy}&skip={skip}&take={take}

Request Information

URI Parameters

Name	Type	Additional information
SiteId	string	None.
StartDate	string	None.
EndDate	string	None.
Start	date	None.
End	date	None.
ExamId	Collection of string	None.
EligibilityId	string	None.
scheduleMethod	ScheduleMethodBindingModel	Default value is Internet
numberOfSlots	integer	Default value is 1
properties	string	None.
orderBy	string	None.
skip	integer	Default value is 0
take	integer	Default value is 50

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

SlotsBindingModel

Name	Description	Type	Additional information
Itinerary		Collection of Itinerary	None.
Suggestions		Collection of Suggestion	None.

Response Formats

application/json, text/json

Sample:

{
  "Itinerary": [
    {
      "Tests": [
        {
          "Duration": 1,
          "Exam": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          },
          "Session": 2
        },
        {
          "Duration": 1,
          "Exam": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          },
          "Session": 2
        }
      ]
    },
    {
      "Tests": [
        {
          "Duration": 1,
          "Exam": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          },
          "Session": 2
        },
        {
          "Duration": 1,
          "Exam": {
            "Id": "sample string 1",
            "Href": "sample string 2"
          },
          "Session": 2
        }
      ]
    }
  ],
  "Suggestions": [
    {
      "Slots": [
        {
          "StartDateTime": "2024-07-01T20:36:24.236734-04:00",
          "Duration": 2,
          "Id": "sample string 3",
          "Href": "sample string 4",
          "GroupId": 5,
          "SessionId": 6
        },
        {
          "StartDateTime": "2024-07-01T20:36:24.236734-04:00",
          "Duration": 2,
          "Id": "sample string 3",
          "Href": "sample string 4",
          "GroupId": 5,
          "SessionId": 6
        }
      ]
    },
    {
      "Slots": [
        {
          "StartDateTime": "2024-07-01T20:36:24.236734-04:00",
          "Duration": 2,
          "Id": "sample string 3",
          "Href": "sample string 4",
          "GroupId": 5,
          "SessionId": 6
        },
        {
          "StartDateTime": "2024-07-01T20:36:24.236734-04:00",
          "Duration": 2,
          "Id": "sample string 3",
          "Href": "sample string 4",
          "GroupId": 5,
          "SessionId": 6
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SlotsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Slot">
  <Itinerary>
    <Itinerary>
      <Tests>
        <Test>
          <Duration>1</Duration>
          <Exam xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1:Id>
          </Exam>
          <Session>2</Session>
        </Test>
        <Test>
          <Duration>1</Duration>
          <Exam xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1:Id>
          </Exam>
          <Session>2</Session>
        </Test>
      </Tests>
    </Itinerary>
    <Itinerary>
      <Tests>
        <Test>
          <Duration>1</Duration>
          <Exam xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1:Id>
          </Exam>
          <Session>2</Session>
        </Test>
        <Test>
          <Duration>1</Duration>
          <Exam xmlns:d6p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
            <d6p1:Href>sample string 2</d6p1:Href>
            <d6p1:Id>sample string 1</d6p1:Id>
          </Exam>
          <Session>2</Session>
        </Test>
      </Tests>
    </Itinerary>
  </Itinerary>
  <Suggestions>
    <Suggestion>
      <Slots>
        <Slots>
          <Duration>2</Duration>
          <GroupId>5</GroupId>
          <Href>sample string 4</Href>
          <Id>sample string 3</Id>
          <SessionId>6</SessionId>
          <StartDateTime>2024-07-01T20:36:24.236734-04:00</StartDateTime>
        </Slots>
        <Slots>
          <Duration>2</Duration>
          <GroupId>5</GroupId>
          <Href>sample string 4</Href>
          <Id>sample string 3</Id>
          <SessionId>6</SessionId>
          <StartDateTime>2024-07-01T20:36:24.236734-04:00</StartDateTime>
        </Slots>
      </Slots>
    </Suggestion>
    <Suggestion>
      <Slots>
        <Slots>
          <Duration>2</Duration>
          <GroupId>5</GroupId>
          <Href>sample string 4</Href>
          <Id>sample string 3</Id>
          <SessionId>6</SessionId>
          <StartDateTime>2024-07-01T20:36:24.236734-04:00</StartDateTime>
        </Slots>
        <Slots>
          <Duration>2</Duration>
          <GroupId>5</GroupId>
          <Href>sample string 4</Href>
          <Id>sample string 3</Id>
          <SessionId>6</SessionId>
          <StartDateTime>2024-07-01T20:36:24.236734-04:00</StartDateTime>
        </Slots>
      </Slots>
    </Suggestion>
  </Suggestions>
</SlotsBindingModel>