API docs by Redocly

Ratality Integration API (1.0)

Download OpenAPI specification:Download

Ratality Support: support@ratality.com

Ratality Integration API Documentation
Build: api-af-v20240715-1854
Visit portal.ratality.com for full documentation.

Session

Create a new JWT Bearer session token

Request Body schema:

User name and password details

username
required
string

Username

password
required
string

Password

rememberMe
boolean

True to keep token valid for 72 Hours

Responses

Request samples

Content type
{
  • "username": "string",
  • "password": "string",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "id_token": "string"
}

Member

Create a new member

Authorizations:
Bearerbasic
Request Body schema:

New member details

siteId
integer <int32>
firstName
string or null
lastName
string or null
title
string or null
dateOfBirth
string or null <date-time>
gender
string or null
email
string or null
cellNumber
string or null
idNumber
string or null

Responses

Request samples

Content type
{
  • "siteId": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "title": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": "string",
  • "email": "string",
  • "cellNumber": "string",
  • "idNumber": "string"
}

Response samples

Content type
application/json
{
  • "memberId": 0,
  • "cardNumber": "string",
  • "title": "string",
  • "firstName": "string",
  • "surname": "string",
  • "idNumber": "string",
  • "dateOfBirth": "string",
  • "gender": "string",
  • "companyName": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "countryCode": "string",
  • "phoneNo": "string",
  • "cellNo": "string",
  • "email": "string",
  • "accommodationDiscountPercentage": 0.1,
  • "foodDiscountPercentage": 0.1,
  • "beveargeDiscountPercentage": 0.1,
  • "other1DiscountPercentage": 0.1,
  • "other2DiscountPercentage": 0.1,
  • "other3DiscountPercentage": 0.1,
  • "banqDiscountPercentage": 0.1,
  • "pointBalance": 0.1
}

Lookup member details

If statusCode is OK, the member was found and is populated in the returned results.
If statusCode is NOT-FOUND, the member was not found and an empty member object is returned. If statusCode is ERROR, the member may be invalid. See statusDescription.

Authorizations:
Bearerbasic
Request Body schema:

Member lookup request

siteId
integer <int32>

Site or Client Id where the member is registered

cardNumber
string or null

Member card number search parameter

emailAddress
string or null

Member email address search parameter

cellphoneNumber
string or null

Member cellphone number search parameter

Responses

Request samples

Content type
{
  • "siteId": 0,
  • "cardNumber": "string",
  • "emailAddress": "string",
  • "cellphoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "statusDescription": "string",
  • "member": {
    }
}

Redeem Loyalty

Authorizations:
Bearerbasic
Request Body schema:
siteId
integer <int32>
cardNumber
string or null
emailAddress
string or null
cellphoneNumber
string or null
object (Invoice)

Responses

Request samples

Content type
{
  • "siteId": 0,
  • "cardNumber": "string",
  • "emailAddress": "string",
  • "cellphoneNumber": "string",
  • "invoice": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": "string",
  • "statusDescription": "string"
}

Update member

Authorizations:
Bearerbasic
Request Body schema:

Member details to update

siteId
integer <int32>
cardNumber
string or null
firstName
string or null
lastName
string or null
title
string or null
dateOfBirth
string or null <date-time>
gender
string or null
email
string or null
idNumber
string or null

Responses

Request samples

Content type
{
  • "siteId": 0,
  • "cardNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "title": "string",
  • "dateOfBirth": "2019-08-24T14:15:22Z",
  • "gender": "string",
  • "email": "string",
  • "idNumber": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "messages": [
    ]
}

Reservation

Send reservation stay records

Authorizations:
Bearerbasic
Request Body schema:
Array of objects or null (StayRecord)

Responses

Request samples

Content type
{
  • "stayRecords": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "messages": [
    ]
}

User

Get user profile details with linked clients/channels

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "username": "string",
  • "clients": [
    ]
}

Breathalyser

BreathalyserAction

Authorizations:
Bearer
header Parameters
client-id
integer <int32>
Request Body schema:
id
string or null

Unique identifier for this record.

dateMeasured
string <date-time>

Date and time measurement is taken

timeZone
string or null

Time Zone the phone is in

bacLevel
number <double>

Breath alcohol level

bacScale
string or null

Measurement scale

calibration
string or null

Whether the device reports that calibration is due

softwareClient
string or null

iSober software version and phone OS

deviceModel
string or null

The breathalyser device model

deviceSerial
string or null

The breathalyser device serial number. If not reported, Bluetooth MAC (Android) Bluetooth identifier (iOS).

firmware
string or null

The breathalyser device firmware version

handset
string or null

Handset make and model

latitude
number or null <double>

Location reading was taken - Latitude decimal value

longitude
number or null <double>

Location reading was taken - Longitude decimal value

address
string or null

Address lookup of latitude/longitude

mainPhoto
string or null

Key to location of main image in file storage

secondaryPhotos
Array of strings or null

Keys to locations of secondary photos in file storage

authenticatedUserUid
string or null

Key to the currently authenticated user

userUid
string or null

Key to the tested subject

userIdNumber
string or null

ID or passport number of subject

userName
string or null

Name and surname of subject

notes
string or null

Notes

Responses

Request samples

Content type
{
  • "id": "string",
  • "dateMeasured": "2019-08-24T14:15:22Z",
  • "timeZone": "string",
  • "bacLevel": 0.1,
  • "bacScale": "string",
  • "calibration": "string",
  • "softwareClient": "string",
  • "deviceModel": "string",
  • "deviceSerial": "string",
  • "firmware": "string",
  • "handset": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "address": "string",
  • "mainPhoto": "string",
  • "secondaryPhotos": [
    ],
  • "authenticatedUserUid": "string",
  • "userUid": "string",
  • "userIdNumber": "string",
  • "userName": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "messages": [
    ]
}

Reports

Get daily sales summary per client.

Authorizations:
Bearer
query Parameters
clientId
integer or null <int32>

Optional client Id

date
string or null

Date from formatted dd-MM-yyyy. Defaults to yesterday

dateTo
string or null

Optional date to formatted dd-MM-yyyy. Used to specify a date range between date and dateTo for multiple days

pageSize
integer <int32>
Default: 100

Query page size. Defaults to 100. Maximum is 500

pageNumber
integer <int32>
Default: 1

Query page number. Defaults to 1

language
string or null
Default: "en"

Optional ISO 639-1 language code. Defaults to 'en'

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "pageSize": 0,
  • "pageNumber": 0,
  • "salesSummaries": [
    ]
}

BusLocation

Get available departure/arrival locations.

The id in each location is used when performing availability requests.

Authorizations:
Bearer
query Parameters
queryString
string or null

Optional wild card query string to match

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "locations": [
    ]
}

BusReservation

Create a new bus reservation

Authorizations:
Bearer
query Parameters
member-id
integer or null <int32>

Optional MemberId

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

channel-terminal
string or null

Optional 3rd party specific Channel Terminal

username
string or null

Optional 3rd party specific Username

Request Body schema:

Bus reservation details

reservationReference
string or null

Unique generated reservation reference

transactionDate
string <date-time>

Date when the reservation was created

totalPrice
number <double>

Total reservation price

reservationStatus
string (ReservationStatus)
Enum: "PENDING_PAYMENT" "RESERVATION_CREATED" "DRAFT" "CANCEL_TIMEOUT" "CANCELLED_PAYMENT_TIMEOUT" "CANCELLED" "PROCESSED" "CONFIRMED_DEPOSIT_RECEIVED" "QUOTATION"
thirdPartyReference
string or null

Third party reference to the reservation

expiryDate
string or null <date-time>

Date when the reservation expires

Array of objects or null (BusTrip)

All trips/routes information for the reservation

object (ReservationPayment)
object (PromotionCode)
seatMapUrl
string or null

Seatmap component URL for all trips. Use within HTML iFrame if available

Responses

Request samples

Content type
{
  • "reservationReference": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "totalPrice": 0.1,
  • "reservationStatus": "PENDING_PAYMENT",
  • "thirdPartyReference": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "trips": [
    ],
  • "payment": {
    },
  • "promotionCode": {
    },
  • "seatMapUrl": "string"
}

Response samples

Content type
application/json
{
  • "reservationReference": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "totalPrice": 0.1,
  • "reservationStatus": "PENDING_PAYMENT",
  • "thirdPartyReference": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "trips": [
    ],
  • "payment": {
    },
  • "promotionCode": {
    },
  • "seatMapUrl": "string"
}

Get bus reservation by reservation reference

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "reservationReference": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "totalPrice": 0.1,
  • "reservationStatus": "PENDING_PAYMENT",
  • "thirdPartyReference": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "trips": [
    ],
  • "payment": {
    },
  • "promotionCode": {
    },
  • "seatMapUrl": "string"
}

Get bus reservation cancel penalty amount

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Cancel bus reservation

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Get bus reservation payment details

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Pay Reservation

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

username
integer <int32>

User name

Request Body schema:

Payment details

object (Payer)
Array of objects or null (PaymentMethod)

Payment Methods

Responses

Request samples

Content type
{
  • "payer": {
    },
  • "paymentMethods": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Apply promotion code for the reservation.

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Request Body schema:

Promotion code object. Only code is required

code
string or null

Promotion code identifier

name
string or null

Promotion name

description
string or null

Description name

bookingFrom
string or null

Booking date valid from, formatted dd-MM-yyyy

bookingTo
string or null

Booking date valid to, formatted dd-MM-yyyy

travelFrom
string or null

Travel date valid from, formatted dd-MM-yyyy

travelTo
string or null

Travel date valid to, formatted dd-MM-yyyy

discountPercentage
number or null <double>

Percentage discount which can be applied. If null, discountAmount to be used.

discountAmount
number or null <double>

Amount discount which can be applied. If null, discountPercentage to be used.

Array of objects or null (Route)

Specific routes to which the promotion can be applied. If empty, the promotion is applicable to all routes.

Responses

Request samples

Content type
{
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "bookingFrom": "string",
  • "bookingTo": "string",
  • "travelFrom": "string",
  • "travelTo": "string",
  • "discountPercentage": 0.1,
  • "discountAmount": 0.1,
  • "routes": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Remove promotion code from the reservation.

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Change bus ticket passengers

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Request Body schema:

Collection of tickets to update passenger details

Array of objects or null (BusTicketBase)

List of Bus Tickets

Responses

Request samples

Content type
{
  • "tickets": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Change bus ticket passengers

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Request Body schema:

Collection of tickets to update passenger details

Array of objects or null (BusTicketBase)

List of Bus Tickets

Responses

Request samples

Content type
{
  • "tickets": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Get bus reservation ticket details

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Reservation ticket reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "passenger": {
    },
  • "thirdPartyReference": "string",
  • "ticketNumber": "string",
  • "ticketPrice": {
    },
  • "nameChangePenalty": {
    },
  • "cancellationPenalty": {
    },
  • "ticketStatus": "PENDING_PAYMENT",
  • "seatClass": "ECONOMY",
  • "seatNumber": "string",
  • "boardingStatus": "CHECKED_IN"
}

Update bus ticket boarding status to `CHECKED_IN` if allowed.

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

username
string or null

Optional overriding username

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Cancel Bus Ticket check-in boarding status.

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

username
string or null

Optional username details

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Get bus ticket cancel penalty amount

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

header Parameters
client-id
integer <int32>

Client Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Cancel Bus Ticket

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

header Parameters
client-id
integer <int32>

Client Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Bus ticket name change penalty details

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

header Parameters
client-id
integer <int32>

Client Id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Change bus ticket name

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

ticketReference
required
string or null

Ticket reference

query Parameters
thirdPartyReference
string or null

Third party reference

header Parameters
client-id
integer <int32>

Client Id

Request Body schema:

Passenger details

title
string or null

Title of person

name
string or null

First Name of person

surname
string or null

Last name of person

object (ContactInformation)
ageGroup
string (AgeGroup)
Enum: "ADULT" "CHILD" "STUDENT" "PENSIONER" "INFANT"
gender
string (Gender)
Enum: "MALE" "FEMALE" "COMPANY"
dateOfBirth
string or null

Date of birth of person

email
string or null

Email address of person

infantTravelling
boolean or null

Is an infant traveling on the lap of the passenger

object (EmergencyContact)
object (IdentityDocument)

Responses

Request samples

Content type
{
  • "title": "string",
  • "name": "string",
  • "surname": "string",
  • "mobileNumber": {
    },
  • "ageGroup": "ADULT",
  • "gender": "MALE",
  • "dateOfBirth": "string",
  • "email": "string",
  • "infantTravelling": true,
  • "emergencyContact": {
    },
  • "identityDocument": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Cancel Bus Tickets

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>
Request Body schema:

Ticket numbers to cancel reference

ticketNumbers
Array of strings or null

List of Bus Tickets Numbers

Responses

Request samples

Content type
{
  • "ticketNumbers": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "monetaryValue": {
    }
}

Add bus tickets to reservation

Authorizations:
Bearer
path Parameters
reservationReference
required
string or null

Reservation reference

tripId
required
integer <int32>

Trip Id

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

username
string or null

Optional 3rd party specific Username

Request Body schema:

New Tickets

Array
object (Passenger)
thirdPartyReference
string or null

Third Party Reference

ticketNumber
string or null

Generated ticket number

object (CurrencyAmount)
object (CurrencyAmount)
object (CurrencyAmount)
ticketStatus
string (TicketStatus)
Enum: "PENDING_PAYMENT" "RESERVATION_CREATED" "DRAFT" "CANCEL_TIMEOUT" "CANCELLED_PAYMENT_TIMEOUT" "CANCELLED" "PROCESSED" "CONFIRMED_DEPOSIT_RECEIVED" "QUOTATION"
seatClass
string (SeatClass)
Enum: "ECONOMY" "BUSINESS" "WHEELCHAIR" "STANDING"
seatNumber
string or null

Ticket Seat Number

boardingStatus
string (BoardingStatus)
Enum: "CHECKED_IN" "NO_SHOW"

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "reservationReference": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "totalPrice": 0.1,
  • "reservationStatus": "PENDING_PAYMENT",
  • "thirdPartyReference": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "trips": [
    ],
  • "payment": {
    },
  • "promotionCode": {
    },
  • "seatMapUrl": "string"
}

Get bus reservation by ticket reference

Authorizations:
Bearer
path Parameters
ticketReference
required
string or null

Reservation ticket reference

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "reservationReference": "string",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "totalPrice": 0.1,
  • "reservationStatus": "PENDING_PAYMENT",
  • "thirdPartyReference": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "trips": [
    ],
  • "payment": {
    },
  • "promotionCode": {
    },
  • "seatMapUrl": "string"
}

BusRoutes

Get available bus routes.

Authorizations:
Bearer
header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "routes": [
    ]
}

Get a bus route.

Authorizations:
Bearer
path Parameters
routeId
required
string or null

Specified route id.

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "routeId": "string",
  • "routeDescription": "string",
  • "dayOfWeekSchedule": {
    }
}

Get bus route schedules.

Authorizations:
Bearer
path Parameters
routeId
required
string or null

Specified route id.

query Parameters
dateFrom
string or null

Date from search for bus schedules formatted dd-MM-yyyy. Defaults to now

dateTo
string or null

Date to search for bus schedules formatted dd-MM-yyyy. Defaults to now + 7 days

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "schedules": [
    ]
}

Get bus route schedule.

Authorizations:
Bearer
path Parameters
routeId
required
string or null

Specified route id.

scheduleId
required
integer <int64>

Specified schedule id.

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "scheduleId": 0,
  • "scheduleDescription": "string",
  • "routeId": "string",
  • "routeDescription": "string",
  • "scheduleStart": "2019-08-24T14:15:22Z",
  • "scheduleEnd": "2019-08-24T14:15:22Z"
}

Get bus route stops.

Authorizations:
Bearer
path Parameters
routeId
required
string or null

Specified route id.

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "stops": [
    ]
}

BusSegments

Get available departure/arrival location segments

The departureLocationId and arrivalLocationId returned are the locationIds between two valid segments within a route.
Availability can be retrieved by using the pair of ids in the availability request.

Authorizations:
Bearer
query Parameters
locationId
integer or null <int32>

Optional locationId filter

primaryLocations
boolean or null

Optional primary indicator to return all primary/most popular route segments (true/false)

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "segments": [
    ]
}

BusTracking

Get available bus tracking entries

Returns a collection of current bus schedule tracking entries where the schedule is active, currently running, and a bus with active vehicle tracking has been assigned.

Authorizations:
Bearer
query Parameters
scheduleId
integer or null <int64>

Optional schedule Id filter

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer or null <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "busTrackings": [
    ]
}

BusTrip

Get available bus trips

Find available routes between two locationIds on a specified departureDate.
departureLocationId and destinationLocationId are locationIds returned by the /bus-locations endpoint.
Valid departureLocationId and destinationLocationId pairs can be found using the /bus-segments endpoint.

Authorizations:
Bearer
query Parameters
departureLocationId
string or null

Departure Station Location Id

destinationLocationId
string or null

Destination Station Location Id

departureDate
string or null

Date to search for bus trips formatted dd-MM-yyyy

numberOfPassengers
string or null

Total number of passengers for the trip

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "trips": [
    ]
}

Get bus trip from id

Authorizations:
Bearer
path Parameters
tripReference
required
integer <int64>

Trip Id

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "tripId": 0,
  • "routeId": "string",
  • "routeDescription": "string",
  • "scheduleId": 0,
  • "departureDate": "2019-08-24T14:15:22Z",
  • "arrivalDate": "2019-08-24T14:15:22Z",
  • "departure": {
    },
  • "destination": {
    },
  • "availableSeats": 0,
  • "price": {
    },
  • "priceClass": {
    },
  • "bookingClasses": [
    ],
  • "discountClasses": [
    ],
  • "tickets": [
    ],
  • "seatMapUrl": "string"
}

Get trip stops.

Retrieve stops for a particular trip.

Authorizations:
Bearer
path Parameters
tripReference
required
integer <int64>

Trip Id

header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "tripStops": [
    ]
}

Promotion

Get available promotion codes for the client

Authorizations:
Bearer
header Parameters
client-id
integer <int32>

Client Id

channel-id
integer <int32>

Channel Id

Responses

Response samples

Content type
application/json
{
  • "promotionCodes": [
    ]
}