Get trip

Get trip
deprecated

Request

Retrieves trip info by ID.

Deprecation notice

The Get Trip /v2/trips/{tripId} endpoint has been deprecated. Use the new Get trip details /v3/trips/{tripId}/detail endpoint instead.

Security

Bearer

Path

tripIdstringrequired

Identifier for trip.

Example:2398199412

curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/trips/2398199412 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

tripIdstringrequired

Spotnana trip Id

Example:"6926658168"

tripNamestringrequired

Name of the trip

Example:"JFK SFO Trip"

tripDescriptionstring

Trip description

Example:"JFK SFO Business Trip"

applicationIdstring, (uuid)

Application id used for the trip.

startDateobject(Date)

Date in ISO 8601 standard.

endDateobject(Date)

Date in ISO 8601 standard.

userIdobject(UserId)

The user Id of the traveler to whom the trip belongs to.

registrarUserIdobject(UserId)

The user Id of the registrar of the adhoc traveler.

tripMetadataobject(TripMetadata)

Metadata for the trip

tripDisabledInfoobject(TripDisabledInfo)

Information regarding whether the trip is disabled and if so, the reason why.

stealthModeobject(StealthMode)

Stealth mode configuration with type and label.

tripLocationsArray of objects(TripLocation)

Locations associated with the trip.

tripHeaderImagesArray of objects(Image)

Header images for the trip, selected by backend based on trip destinations.

stealthTypestring(StealthType)deprecated

Stealth type.

Enum:"STEALTH_TYPE_1""STEALTH_TYPE_2""STEALTH_TYPE_3"

Example:"STEALTH_TYPE_1"

Response

{
  "tripId": "6926658168",
  "tripName": "JFK SFO Trip",
  "tripDescription": "JFK SFO Business Trip",
  "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
  "startDate": {
    "iso8601": "2017-07-21"
  },
  "endDate": {
    "iso8601": "2017-07-21"
  },
  "userId": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "registrarUserId": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "tripMetadata": {
    "hasTripOverride": true,
    "preferredCurrency": "USD",
    "tripContacts": [ … ],
    "tripCommunicationPreferences": { … }
  },
  "tripDisabledInfo": {
    "disabledReason": "MAX_BOOKINGS_EXCEEDED",
    "isDisabled": false
  },
  "stealthType": "STEALTH_TYPE_1",
  "stealthMode": {
    "stealthType": "STEALTH_TYPE_1",
    "label": "string"
  },
  "tripLocations": [
    { … }
  ],
  "tripHeaderImages": [
    { … }
  ]
}

Get trip deprecated

Request

Path

Responses

Get trip
deprecated