OTA API Settings

From KB
Revision as of 11:39, 18 September 2024 by Angela (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Location

Data Link Log: SETTINGS > Data Links


Purpose

The Open Travel Alliance Application Programming Interface (OTA API) is an interface that allows communication with RentWorks via Extensible Markup Language (XML) messages. An outside system sends requests to the API and receives responses with the requested information or action.

Please note that this is an add-on module and per text fees apply. There are also additional set-up requirements. Please see the OTA API RentWorks Setings Guide.


Fields - OTA Tab

Target - Returns “Test” or “Production” in the response’s Target attribute.

Distance Units - The unit attributes can be set for miles or kilometers.

Vendor Code - The code that is returned in the Vendor element.

3-Letter Currency Code - The currency code returned in currency elements. If this field is blank, “XXX” will be returned.

Availability Checking: Each class is listed in the browser. There are three options for calculating availability.

  • None: Availability is not calculated.
  • Quick: Vehicles are shown as available unless a special event is blacking out the class.
  • Full: The full availability calculation is performed.

Locations - If only some locations are to be used in the API, select those locations in this list. If none are selected, all locations are used.

Classes - If only some classes are to be used in the API, select those classes in this list. If none are selected, all classes are used.

Require Password Authentication - If this box is checked, a valid username and password is required to be sent with each API request. The usernames and passwords are maintained with the fields in the box. If a request is sent without a valid username and password, the request will be rejected and an authentication error will be returned.

Fields - Vehicle Info Tab

Available Fields/Field to Include - Highlight then click on Add or Del(ete) to move all of the available vehicle data elements to those to be included in the API.

Default Grounding Date Limit - Enter the default grounding date limit to be used when selecting vehicles.

Default Grounding Mileage Limit - Enter the default grounding mileage limit to be used when selecting vehicles.