Trip API (v2)

Download OpenAPI specification:Download

Trips

APIs to manage trips and PNRs.

List trips

This endpoint returns the trips and associated PNR's for an organisation, depending on the updated time and pnrType.

SecurityBearer
Request
Request Body schema: application/json
required
object (OrganizationId)

Organization id for traveler.

object (DateTimeOffset)

ISO8601 UTC Date Time

pnrType
required
string

Type of PNR

Enum: "AIR" "CAR" "RAIL" "HOTEL" "LIMO" "ALL"
Array of objects (CustomFieldId)

List of custom field IDs to filter

Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/v2/list-organisation-trips
Request samples
application/json
{
  • "organizationId": {
    },
  • "updatedAt": {
    },
  • "pnrType": "AIR",
  • "customFieldIds": [
    ]
}
Response samples
application/json
{
  • "trips": [
    ]
}

Create trip

This endpoint creates a trip object. A trip is a container object for all related PNRs associated with a trip.

SecurityBearer
Request
Request Body schema: application/json
tripName
required
string

Name of the trip.

tripDescription
string

Description of the trip.

object (UserId)

User identifier

object (UserId)

Creator of the Trip.

Responses
201

Created

400

Bad request

401

Unauthorized

403

Forbidden

post/v2/trips
Request samples
application/json
{
  • "tripName": "string",
  • "tripDescription": "string",
  • "userId": {
    },
  • "registrarId": {
    }
}
Response samples
application/json
{
  • "id": "string"
}

Get trip

This endpoint gets trip by ID.

SecurityBearer
Request
path Parameters
tripId
required
string

Identifier for trip.

Example: 2398199412
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v2/trips/{tripId}
Request samples
Response samples
application/json
{
  • "tripId": "6926658168",
  • "tripName": "JFK SFO Trip",
  • "tripDescription": "JFK SFO Business Trip",
  • "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  • "startDate": {
    },
  • "endDate": {
    }
}

Update trip

This endpoint updates trip by ID.

SecurityBearer
Request
path Parameters
tripId
required
string

Identifier for trip.

Example: 2398199412
Request Body schema: application/json
tripId
required
string

Spotnana trip Id

tripName
required
string

Name of the trip

tripDescription
string

Trip description

Responses
204

Updated Successfully

400

Bad request

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/v2/trips/{tripId}
Request samples
application/json
{
  • "tripId": "6926658168",
  • "tripName": "JFK SFO Trip",
  • "tripDescription": "JFK SFO Business Trip"
}
Response samples
application/json
{
  • "debugIdentifier": "string",
  • "errorMessages": [
    ]
}

Get trip details

This endpoint gets trip details for a given trip ID.

SecurityBearer
Request
path Parameters
tripId
required
string

Trip ID

Example: 6926658168
Responses
200

OK

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/v3/trips/{tripId}/detail
Request samples
Response samples
application/json
{
  • "basicTripInfo": {
    },
  • "pnrs": [
    ],
  • "pendingShellPnrs": [
    ],
  • "pendingManualFormPnrs": [