GET api/v1/sites/{siteId}/holds/{holdId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

string

Required
holdId

integer

Required

Body Parameters

None.

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-07-01T20:43:19.9533003-04:00",
  "Id": "sample string 4",
  "ExpirationDateTime": "2024-07-01T20:43:19.9533003-04: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-07-01T20:43:19.9533003-04: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-07-01T20:43:19.9533003-04:00</ProctorStart>
  <ProctorTimeZone>sample string 2</ProctorTimeZone>
</HoldBindingModel>