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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

string

Required
holdId

integer

Required

Body Parameters

None.

Response Information

Resource Description

V0HoldBindingModel
NameDescriptionTypeAdditional information
Uri

string

None.
Legacy

LegacyBindingModel

None.
CandidateTimezoneOffset

time interval

None.
Id

string

None.
ExpirationDateTime

date

None.
Slot

ResourceReferenceOfString

None.

Response Formats

application/json, text/json

Sample: 
{
  "Uri": "sample string 1",
  "Legacy": {
    "SeatId": 1,
    "LabId": 2
  },
  "CandidateTimezoneOffset": "00:00:00.1234567",
  "Id": "sample string 2",
  "ExpirationDateTime": "2025-11-04T00:37:02.7508001-05:00",
  "Slot": {
    "Id": "sample string 1",
    "Href": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<V0HoldBindingModel 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">2025-11-04T00:37:02.7508001-05:00</ExpirationDateTime>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</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>
  <CandidateTimezoneOffset>PT0.1234567S</CandidateTimezoneOffset>
  <Legacy>
    <LabId>2</LabId>
    <SeatId>1</SeatId>
  </Legacy>
  <Uri>sample string 1</Uri>
</V0HoldBindingModel>