Travel Api
< BACK

ThirdParty - v1.0.0 Client

The thirdparty api expose a group of methods for booking and invoices management.

Api Messages

Api Authorization

Api Key
Api Secret
Token:
If you already have a token, you can put it here directly.
The token must be embeded in the request as "AuthToken" HTTP Header or as "authtoken" Querystring Parameter.
The examples in this client uses the token as a querystring parameter.

Method: GET

Description: If the agency parameter is defined, get the information for the agency, otherwise; get all agencies information for an enterprise.

Route: tp/agencies/{enterprise}/{agency:int?}

Input Parameters: enterprise, agency [optional, default=(null)]

CacheResponse Header: 10 seconds

Response Object: ApiAgenciesRS (XSD / Schema)

Request

enterprise:
agency [optional]:

Response

Url:
Response:

Method: GET

Description: If the booking parameter is defined, gets a booking information, otherwise; get all bookings for an enterprise. The max value is used to limit the result length.

Route: tp/bookings/{enterprise}

Route: tp/bookings/{enterprise}/{booking}

Route: tp/bookings/{enterprise}/{max:int}

Input Parameters: enterprise, booking [optional, default=(null)], max [optional, default=10]

CacheResponse Header: 2 seconds

Response Object: ApiBookingsRS (XSD / Schema)

Request

enterprise:
booking [optional]:
max [optional]:

Response

Url:
Response:

Method: DELETE

Description: Cancels an existing booking.

Route: tp/bookings/{enterprise}/{agency:int}/{booking}

Input Parameters: enterprise, agency, booking

Response Object: ApiBookingCancelRS (XSD / Schema)

Request

enterprise:
agency:
booking:

Response

Url:
Response:

Method: POST

Description: Adds a new booking.

Route: tp/bookings

Input Parameters: Body

Request Object:ApiBookingAddRQ (XSD / Schema)

Response Object: ApiBookingAddRS (XSD / Schema)

Request

Request Body:

Response

Url:
Response:

Method: GET

Description: Get an invoice data from and enterprise and invoice number.

Route: tp/invoices/{enterprise}/{number}

Input Parameters: enterprise, number

CacheResponse Header: 2 seconds

Response Object: ApiInvoiceRS (XSD / Schema)

Request

enterprise:
number:

Response

Url:
Response:

Method: DELETE

Description: Remove an existing invoice.

Route: tp/invoices/{enterprise}/{agency:int}/{booking}/{invoice}

Input Parameters: enterprise, agency, booking, invoice

Response Object: ApiInvoiceRS (XSD / Schema)

Request

enterprise:
agency:
booking:
invoice:

Response

Url:
Response:

Method: POST

Description: Adds a new invoice.

Route: tp/invoices

Input Parameters: Body

Request Object:ApiInvoiceAddRQ (XSD / Schema)

Response Object: ApiInvoiceRS (XSD / Schema)

Request

Request Body:

Response

Url:
Response:

Method: POST

Description: Adds a new payment information.

Route: tp/paymentcb

Input Parameters: Body

Request Object:ApiPaymentCbAddRQ (XSD / Schema)

Response Object: ApiPaymentCbAddRS (XSD / Schema)

Request

Request Body:

Response

Url:
Response: