JSON API - MODIFYRES
All reservation changes will be handled with TransType "MODIFYRES".
Modifications will be passed as an array of items to be removed or added.
Restrictions
This method cannot operate on cancelled bookings
Possible error message: “You are not authorized to modify this reservation”.
Input
TransType
-MODIFYRES
Login
- API user loginPassword
- API user passwordResNumber
- ResNumber of the reservation to updateRemoveServices
- Comma-separated list of ServiceSeqs to be removed from the reservationServiceSeqs are returned by the
GETRES
API method.ServiceSeq
is an integer unique per reservation service.
AddServices
- JSON array ofBookCommand
objects representing services to be added to the reservationBookCommands are returned by the SHOP API method. These objects will behave the same way as in the "BOOK" API method.
MakeActive
- String (Y/N) to indicate whether to force theResStatus
on the reservation to Active (default: N).Set the value to "Y" to set the reservation's ResStatus to "A"
Set the value to "N" to keep the reservation's ResStatus the same (no change)
This will only take effect if the current ResStatus on the reservation is Q (quote). Other ResStatuses will return an error. Option bookings MUST go through the conversion process. Cancelled bookings CANNOT be make active.
This will only change the
ResStatus
on the reservation. It will not affect accounting, total received, transactions, etc.
Output
The output of the new MODIFYRES
will be either an error (if the modifications failed), or the updated reservation object (same output as GETRES
).
Example
TransType=MODIFYRES
&Login=MyLogin
&Password=MyPassword
&RemoveServices=23,24
&AddServices=[
{
"productcode": "MYPRODUCT",
"brandid": "MYBRAND",
"itemnumber": 0,
"inclusionnumber": 0,
"supplierid": "US-PHLSFT",
"serviceid": "SVC1",
"departuredate": "2018-11-08",
"duration": 4,
"mask": "A",
"qcurrency": "USD",
"sellmethod": "WEB",
"extsvcref": "ExtRef"
}
]
&MakeActive=Y
ServiceSeq
ServiceSeq can be retrieved from the GETRES response:
{
"serviceseq": 1,
"confinfo": "",
"productcode": "MYPRODUCT",
"seq": 100,
"iseq": 340,
"itemrole": "O",
"requestedmask": "A",
"servicetype": "TRF",
"servicetypename": "Transfer",
"servicedate": "2018-05-14",
"servicetime": "08:00",
"serviceduration": 1,
"supplierid": "US-PHLSFT",
...
}
Example
login=[Login]
&password=[Password]
&TransType=MODIFYRES
&ResNumber=[ResNumber]
&makeactive=Y
&removeservices=10,12
&addservices=[{BookCommand},{BookCommand}]