DELETE api/v2/bookings?ids={ids}&transactionIds={transactionIds}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ids | string |
Required |
|
| transactionIds | string |
None. |
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:
Response Information
Resource Description
BookingBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| Href | string |
None. |
|
| Candidate | ResourceReferenceOfString |
None. |
|
| Tests | Collection of TestBindingModel |
None. |
|
| Payments | Collection of ResourceReferenceOfString |
None. |
|
| TestingAccommodations | Collection of BaseTestingAccommodationBindingModel |
None. |
Response Formats
application/json
Sample:
text/json
Sample:
application/xml, text/xml
Sample:
<BookingBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models.Booking">
<Candidate xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</Candidate>
<Href>sample string 3</Href>
<Id>sample string 1</Id>
<Payments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d2p1:ResourceReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ResourceReferenceOfstring>
<d2p1:ResourceReferenceOfstring>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
</d2p1:ResourceReferenceOfstring>
</Payments>
<TestingAccommodations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
<d2p1:BaseTestingAccommodationBindingModel>
<d2p1:Attributes>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
</d2p1:Attributes>
<d2p1:CategoryId>4</d2p1:CategoryId>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Name>sample string 3</d2p1:Name>
</d2p1:BaseTestingAccommodationBindingModel>
<d2p1:BaseTestingAccommodationBindingModel>
<d2p1:Attributes>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
<d2p1:AttributeBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Parameters>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
<d2p1:ParameterBindingModel>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:ParameterBindingModel>
</d2p1:Parameters>
</d2p1:AttributeBindingModel>
</d2p1:Attributes>
<d2p1:CategoryId>4</d2p1:CategoryId>
<d2p1:Href>sample string 2</d2p1:Href>
<d2p1:Id>sample string 1</d2p1:Id>
<d2p1:Name>sample string 3</d2p1:Name>
</d2p1:BaseTestingAccommodationBindingModel>
</TestingAccommodations>
<Tests>
<TestBindingModel>
<CNATT>true</CNATT>
<Eligibility xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d4p1:Href>sample string 2</d4p1:Href>
<d4p1:Id>sample string 1</d4p1:Id>
</Eligibility>
<Exam xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d4p1:Href>sample string 2</d4p1:Href>
<d4p1:Id>sample string 1</d4p1:Id>
</Exam>
<IsExternalClientCall>true</IsExternalClientCall>
<Sessions>
<SessionBindingModel>
<CanReschedule>true</CanReschedule>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
<ExamFormCode>sample string 5</ExamFormCode>
<Hold 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>
</Hold>
<IsGetCall>true</IsGetCall>
<SessionId>2</SessionId>
</SessionBindingModel>
<SessionBindingModel>
<CanReschedule>true</CanReschedule>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
<ExamFormCode>sample string 5</ExamFormCode>
<Hold 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>
</Hold>
<IsGetCall>true</IsGetCall>
<SessionId>2</SessionId>
</SessionBindingModel>
</Sessions>
<Status>sample string 1</Status>
<TestingAccommodations>
<TestingAccommodationBindingRequestModel>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
<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 xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
<Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
<Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
<Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
</TestingAccommodationBindingRequestModel>
<TestingAccommodationBindingRequestModel>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
<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 xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
<Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
<Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
<Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
</TestingAccommodationBindingRequestModel>
</TestingAccommodations>
</TestBindingModel>
<TestBindingModel>
<CNATT>true</CNATT>
<Eligibility xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d4p1:Href>sample string 2</d4p1:Href>
<d4p1:Id>sample string 1</d4p1:Id>
</Eligibility>
<Exam xmlns:d4p1="http://schemas.datacontract.org/2004/07/Prometric.Api.Models">
<d4p1:Href>sample string 2</d4p1:Href>
<d4p1:Id>sample string 1</d4p1:Id>
</Exam>
<IsExternalClientCall>true</IsExternalClientCall>
<Sessions>
<SessionBindingModel>
<CanReschedule>true</CanReschedule>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
<ExamFormCode>sample string 5</ExamFormCode>
<Hold 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>
</Hold>
<IsGetCall>true</IsGetCall>
<SessionId>2</SessionId>
</SessionBindingModel>
<SessionBindingModel>
<CanReschedule>true</CanReschedule>
<ConfirmationNumber>sample string 1</ConfirmationNumber>
<ExamFormCode>sample string 5</ExamFormCode>
<Hold 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>
</Hold>
<IsGetCall>true</IsGetCall>
<SessionId>2</SessionId>
</SessionBindingModel>
</Sessions>
<Status>sample string 1</Status>
<TestingAccommodations>
<TestingAccommodationBindingRequestModel>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
<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 xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
<Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
<Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
<Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
</TestingAccommodationBindingRequestModel>
<TestingAccommodationBindingRequestModel>
<Attributes xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">
<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 xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">4</CategoryId>
<Href xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 2</Href>
<Id xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 1</Id>
<Name xmlns="http://schemas.datacontract.org/2004/07/Prometric.Scheduling.Api.Models">sample string 3</Name>
</TestingAccommodationBindingRequestModel>
</TestingAccommodations>
</TestBindingModel>
</Tests>
<Uri>sample string 2</Uri>
</BookingBindingModel>