RightRez Web API Help Page

Introduction

This API is still under active development and parts are relatively unstable. Develop against it while this message remains posted at your own risk.

The RightRez Web API is an ongoing project which aims to expose all of the important core functionality of our codebase via JSON over RESTful HTTP web services. The documentation on this page for the API calls is generated from the codebase, and provides detailed information about all of the parameters, options, return values, and has realistic sample requests and responses. Additionally, there is a development guide and a growing collection of code samples to accompany this page.

These services are provided as an alternative to our Just-in-time Booking Service and other SOAP based point of sale services, and can in fact be used to drive the existing point of sale flow. This is how we now implement it on our pages, through client side calls to the FlightAvailability API methods to get cached responses and select point of sale flights.

Provide a general description of your APIs here.

Request and Response Format
The majority of the API methods accept only JSON format, with the exception being the authentication method at 'api/Token', which accepts url encoded input. Additionally, all services are setup to accept cross origin requests, allowing the API to be consumed directly in browser via javascript in all modern browsers.

All responses are returned in JSON format, allowing for easy consumption on a wide variety of platforms. The JSON is optimized for size, meaning that default and null values will not be serialized on the response. Be sure to take this into consideration when developing against the API.

Authentication

All of our web API services require authentication to use, in the form of OAuth 2 resource owner grant authentication flow with bearer tokens. The authentication token (and an authentication cookie if done in javascript in a web browser) are created by posting a rather simple form-encoded payload to the resource at 'https://softapi.rightrez.com/api/Token'

Headers:

application/x-www-form-urlencoded

Data:

grant_type=password&username=myUserName&password=secret

This returns a json response of the form

{
    "access_token":"msz6IOEyAJQgGAhZBC-E7WB-2hcF1bLjKbBmEKCVhoDY1SO7OwT...
    "token_type":"bearer",
    "expires_in":1209599,
    "userName":"myUserName",
    ".issued":"Tue, 04 Mar 2014 19:52:51 GMT",
    ".expires":"Tue, 18 Mar 2014 19:52:51 GMT"
}

and with the authentication cookie on the response header will be added to the browser if this is done via javascript.

In practice there are 2 sorts of logins, standard logins which are mapped to accounts that are stored in our system, and point of sale logins, which are tied to doing a single booking then expire, or are tied to viewing and performing actions on a single reservation.

Keep this token protected, if it falls into the wrong hands then a malicious user could make requests on your behalf. In a production environment, the API is served over https, minimizing the chances of an attacker getting access to your token just by listening to the wire, but beyond that, we still suggest taking special care in keeping it a secret.

UserSelfManagent

API	Description
GET breeze/UserSelfManagent/Metadata	No documentation available.
POST breeze/UserSelfManagent/SaveChanges	No documentation available.
GET breeze/UserSelfManagent/Users	No documentation available.
POST api/UserSelfManagent	No documentation available.

UserManagement

API	Description
GET breeze/UserManagement/Metadata	No documentation available.
POST breeze/UserManagement/SaveChanges	No documentation available.
GET breeze/UserManagement/Clients	No documentation available.
GET breeze/UserManagement/ClientSettings	No documentation available.
GET breeze/UserManagement/Users	No documentation available.
GET breeze/UserManagement/Groups	No documentation available.
GET breeze/UserManagement/Roles	No documentation available.
POST api/UserManagement	No documentation available.

SupportLogMessage

API	Description
POST api/Support/Search	No documentation available.
POST api/Support	No documentation available.

Log

API	Description
POST api/log/retrieve	No documentation available.
POST api/log/secondary	No documentation available.
POST api/log/search	No documentation available.
GET api/log/port/{id}	No documentation available.

Carrier

API	Description
GET api/Carrier	No documentation available.
GET api/Carrier/{id}	No documentation available.
POST api/Carrier/{id}/clearLogo	No documentation available.
POST api/Carrier/{id}/uploadLogo	No documentation available.

FlightAvailability

API	Description
GET api/FlightAvailability/{id}	No documentation available.
GET api/FlightAvailability/Selected/{id}	No documentation available.
POST api/FlightAvailability/SelectFlight	No documentation available.
POST api/FlightAvailability	No documentation available.
POST api/FlightAvailability/PriceUpsell	No documentation available.
POST api/FlightAvailability/More	No documentation available.
POST api/FlightAvailability/Seats	No documentation available.
POST api/FlightAvailability/EmailQuotePreview	No documentation available.
POST api/FlightAvailability/SendEmailQuote	No documentation available.

Route

API	Description
GET api/r	No documentation available.
POST api/routes	No documentation available.

Account

API	Description
GET api/Account/UserInfo	No documentation available.
POST api/Account/Logout	No documentation available.
GET api/Account/Clients	No documentation available.
GET api/Account/Permissions	No documentation available.
GET api/Account/Settings	No documentation available.
GET api/Account/Settings/{clientId}	No documentation available.
GET api/Account/ReportServerReports	No documentation available.
GET api/Account/Cookie	No documentation available.
GET api/Account/TokenFromCookie	No documentation available.
GET api/Account/AuthenticateExternalRequest/{requestId}	No documentation available.
GET api/Account/Impersonate/{username}	No documentation available.
GET api/Account/ManageInfo?returnUrl={returnUrl}&generateState={generateState}	No documentation available.
POST api/Account/ChangePassword	No documentation available.
POST api/Account/AdminChangePassword	No documentation available.
POST api/Account/SetPassword	No documentation available.
POST api/Account/AddExternalLogin	No documentation available.
POST api/Account/RemoveLogin	No documentation available.
GET api/Account/ExternalLogin?provider={provider}&error={error}	No documentation available.
GET api/Account/ExternalLogins?returnUrl={returnUrl}&generateState={generateState}	No documentation available.
POST api/Account/Register	No documentation available.
POST api/Account/RegisterExternal	No documentation available.
POST api/Account/FinishPasswordReset	No documentation available.
POST api/Account/GetPasswordResetToken	No documentation available.
POST api/Account/StartPasswordReset	No documentation available.

Admin

API	Description
GET api/Admin/Versions?all={all}	No documentation available.
GET api/Admin/Settings	No documentation available.
GET api/Admin/{clientId}/Permissions	No documentation available.

Airports

API	Description
GET api/Airports	No documentation available.
GET api/Countries	No documentation available.
GET api/Continents	No documentation available.
GET api/Zones	No documentation available.

ProgramInfo

API	Description
POST api/ProgramInfo/CompanyProgramProduct/Copy	No documentation available.
GET api/ProgramInfo/{clientId}/CompanyProgramProduct/{company}/export	No documentation available.
GET api/ProgramInfo/{clientId}/AccountingCodes	No documentation available.
GET api/ProgramInfo/{clientId}/BookingTypes	No documentation available.
POST api/ProgramInfo/Cities	No documentation available.
GET api/ProgramInfo/{clientId}/CompanyProgramProduct/{productLevelId}	No documentation available.
GET api/ProgramInfo/{clientId}/CompaniesProgramsProducts?ids[0]={ids[0]}&ids[1]={ids[1]}	No documentation available.
GET api/ProgramInfo/{clientId}/DepartmentCodes/{bookingType}	No documentation available.
POST api/ProgramInfo/TimePrefs	No documentation available.
GET api/ProgramInfo/{clientId}/Ships	No documentation available.
POST api/ProgramInfo/{clientId}/Import/{companyId}/import?hasHeaders={hasHeaders}&overwrite={overwrite}	No documentation available.

FlightBooking

API	Description
POST api/FlightBooking	No documentation available.
POST api/FlightBooking/GetPnr	No documentation available.
POST api/FlightBooking/GetNotes	No documentation available.
POST api/FlightBooking/AddNote	No documentation available.
POST api/FlightBooking/SendEmail	No documentation available.
POST api/FlightBooking/Cancel	No documentation available.
POST api/FlightBooking/ChangePassengers	No documentation available.
POST api/FlightBooking/ChangeInfo	No documentation available.
POST api/FlightBooking/ScheduleForTicketing	No documentation available.
POST api/FlightBooking/Seats	No documentation available.
POST api/FlightBooking/SetABLines	No documentation available.
POST api/FlightBooking/GetExceptions	No documentation available.
POST api/FlightBooking/DeleteApproval	No documentation available.
POST api/FlightBooking/AddApprovals	No documentation available.

Nationality

API	Description
GET api/Nationality	No documentation available.
GET api/Nationality/{id}	No documentation available.

Notification

API	Description
POST api/Notification	No documentation available.

Workflows

API	Description
GET api/Workflows/{clientId}	No documentation available.
POST api/Workflows/GetWorkflow	No documentation available.
POST api/Workflows/Search	No documentation available.
POST api/Workflows/Actions/Apply	No documentation available.
POST api/Workflows/Actions/ApplyToAll	No documentation available.
POST api/Workflows/Search/Export	No documentation available.

Modules

API	Description
POST api/Modules/{clientId}/batch/{batchJobId}/start	No documentation available.
POST api/Modules/{clientId}/batch/{batchJobId}/cancel	No documentation available.
POST api/Modules/{clientId}/batch/{batchJobId}/restart	No documentation available.
POST api/Modules/{clientId}/batch/upload/{type}	No documentation available.
GET api/Modules/{clientId}/batch/{batchId}/results	No documentation available.

GdsQueueInfo

API	Description
GET api/GdsQueueInfo/{clientId}/Count/{queueNumber}/{categoryNumber}/{dateRange}	No documentation available.