GET api/v2/holds?validate={validate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validate

boolean

Default value is False

Body Parameters

Collection of integer

Request Formats

application/json, text/json

Sample:
[
  1,
  2
]

application/xml, text/xml

Sample:
<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <int>1</int>
  <int>2</int>
</ArrayOfint>

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 'List`1'.

Response Information

Resource Description

HoldBindingModel
NameDescriptionTypeAdditional information
Href

string

None.

ProctorTimeZone

string

None.

ProctorStart

date

None.

Id

string

None.

ExpirationDateTime

date

None.

Slot

ResourceReferenceOfString

None.

Response Formats

application/json, text/json

Sample:
{
  "Href": "sample string 1",
  "ProctorTimeZone": "sample string 2",
  "ProctorStart": "2024-11-21T04:55:12.0902245-05:00",
  "Id": "sample string 4",
  "ExpirationDateTime": "2024-11-21T04:55:12.0902245-05:00",
  "Slot": {
    "Id": "sample string 1",
    "Href": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<HoldBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Hold">
  <ExpirationDateTime xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">2024-11-21T04:55:12.0902245-05:00</ExpirationDateTime>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 4</Id>
  <Slot xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
    <d2p1:Href>sample string 2</d2p1:Href>
    <d2p1:Id>sample string 1</d2p1:Id>
  </Slot>
  <Href>sample string 1</Href>
  <ProctorStart>2024-11-21T04:55:12.0902245-05:00</ProctorStart>
  <ProctorTimeZone>sample string 2</ProctorTimeZone>
</HoldBindingModel>