Client backoffice
ClientBackoffice contracts
Our Client Backoffice API provides a set of methods that can be very helpful for clients of a Cangooroo license owner to integrate with backoffice system and ERP. In other words this is to used with users attached to client / agency level in Cangooroo.
Also there are some other methods that allow automation of a variety of process.
Below you find a list of available methods:
GetLastFXRate
In this method, retrieve the exchange information registered for the user agency used.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
The criteria fields will be used in the search for currency conversion:
"CurrencyCodeFrom": "?",
"CurrencyCodeTo": "?",
"ServiceType": "?"
GetIncidents
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
The UserName space is where you're supposed to put in the UserName given you by the Operator. While the Password is where you're supposed to insert the Password given you by the Operator.
Criteria
The criteria fields will be used in the search for incidences.
"Incident": {
"BookingId": "?",
"CreationDateEnd": "?",
"CreationDateStart": "?",
"IncidentId": "?",
"Message": "?",
"SendEmail": "?",
"ServiceId": "?",
"Status": "?",
"Title": "?"
}
}
CreatIncident
Use this method to create a new incident for an existing service.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
The UserName space is where you're supposed to put in the UserName given you by the Operator. While the Password is where you're supposed to insert the Password given you by the Operator.
The completed information will be used to create the occurrence:
"Incident": {
"BookingId": "?",
"Message": "?",
"SendEmail": "?",
"ServiceId": "?",
"Title": "?"
}
AddIncidentMessage
Use this method to add a message to an existing incidence.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
The completed information will be added in a new message in the occurrence
"IncidentMessage": {
"Message": "?",
"OccurrenceId": "?",
"Title": "?",
"Type": "?"
}
Type
There are two types of occurrence:
Request
Occurrence
Authenticate
Use this method to perform authentication with the user and password given you by the operator.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
GetBookingList
Use this method to get an list of reservations from the client.
The criteria fields will be used in the search for reservations.
"SearchBookingCriteria": {
"BookingNumber": [],
"BookingStatus": [],
"CancelationDateEnd": "?",
"CancelationDateStart": "?",
"ExternalReference": "?",
"FinalBookingDate": "?",
"FinalServiceDate": "?",
"FinalUpdateDate": "?",
"InitialBookingDate": "?",
"InitialServiceDate": "?",
"InitialUpdateDate": "?",
"PassengerName": "?",
"PaymentDeadlineEnd": "?",
"PaymentDeadlineStart": "?",
"ServiceTypes": []
}
ServiceTypes
There are eight types of service:
Hotel
Insurance
Tour
Transfer
RentACar
Flight
Circuit
Package
GetBookingDetail
Use this method to get detailed information about an reservation.
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
Enter the reservation id for information:
"BookingId": "?"
CancelBooking
Use this method to cancel all services in a file (reservation).
CancelBooking Request
Credential
The credentials tag is fairly simple and only has the UserName and the Password as shown below:
{
"Credential": {
"Username": "Your_Username",
"Password": "Your_Password"
},
Enter the the bookingId of a reservation to be canceled
"BookingId": ?
CancelBooking Response
In the answer of this method the customer can see the status of his reservation and verify that it has been successfully canceled, it is worth noting that if a reservation is canceled after its cancellation policies take effect, the customer may pay a fine for the service.
URL and Examples
SOAP
http://ws-[clientIdentification].cangooroo.net/API/SOAP/ClientBackOffice.svc
REST
REST: http://ws-[clientIdentification].cangooroo.net/API/REST/ClientBackOffice.svc