Cancel Hold
Request Profile Table
Element | @Attribute |
Description/Contents |
CancelHold_RQ |
Root element of message |
BookingAgent |
Element representing the booking agent
To specify an agent you can just provide either the ID, or the GUID. If both are provided ResLink will make a check to see if the GUID and ID match in the database and will error out if they don't. |
ID |
ID of the booking agent |
GUID |
GUID identifier for booking agent |
HoldID |
ID of the Hold to cancel |
Name |
Reference name of the Hold to cancel |
Scenario:
You want to cancel a hold with Hold ID of 1 for a Test agent
Example message:
<?xml version="1.0" encoding="utf-8"?>
<CancelHold_RQ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<BookingAgent xmlns="ResLink">
<GUID>TEST</GUID>
</BookingAgent>
<HoldID xmlns="ResLink">1</RunID>
<Name xmlns="ResLink">John Doe Hold</Name>
</CancelHold_RQ>
Response Profile Table
Element | @Attribute |
Description/Contents |
CancelHold_RS |
Root element of message. |
Success |
Indicates if the Hold was cancelled successfully |
Example message:
<?xml version="1.0" encoding="utf-8"?>
<CancelHold_RS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ID xmlns="ResLink">WR6699</ID>
<Status Code="0" Message="Hold cancelled successfully" xmlns="ResLink" />
<Success xmlns="ResLink">true</HoldID>
<TimeStamp xmlns="ResLink"> 2014-08-20T14:53:11.6351068+10:00</TimeStamp>
<Errors xmlns="ResLink" />
<Warnings xmlns="ResLink" />
</CancelHold_RS>