GET api/v1/holds/{holdId}?validate={validate}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
holdId | integer |
Required |
|
validate | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
HoldBindingModelName | Description | Type | Additional 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-12-03T11:38:32.5354704-05:00", "Id": "sample string 4", "ExpirationDateTime": "2024-12-03T11:38:32.5354704-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-12-03T11:38:32.5354704-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-12-03T11:38:32.5354704-05:00</ProctorStart> <ProctorTimeZone>sample string 2</ProctorTimeZone> </HoldBindingModel>