Skip to main content

Get Trip Avoid Favors

Trip Management’s get trip avoid favors API gets customer supplied avoid favor ids or names for a given trip.

The following two variations of requests are supported for this functionality:

GET /trip/{tripId}/avoidFavors

Resource URL

https://tripmanagement.alk.com/api/trip/{tripId}/avoidFavors

Request Fields

Field Description Type Required
tripId The alkTripId returned when you planned the trip.
integer
Yes

GET /trip/avoidFavors?tripId={tripId}

Resource URL

https://tripmanagement.alk.com/api/trip/avoidFavors?tripId={tripId}

Request Fields

Field Description Type Required
tripId The alkTripId returned when you planned the trip or the tmsTripId in your planning system.
Note: Only one can be used when making a request through the URL. The search logic will check for the user’s trips with matching tmsTripId. If no trips are found with provided tmsTripId, then the check will continue for trips with matching alkTripId. If no trip is found matching with either of the Trip IDs, then no trip found response will be returned.
integer
or
string
Yes

Response Fields

Same response for both the types of requests

Field Description Type
tripId The trip identifier.
integer
afSetIds An array of avoid favor set ids.
Array <integer>
afSetNames An array of avoid favor set names.
Array <string>

Example

Sample Response

{
  "tripId": 410602,
  "afSetIds": [
    2,
    3,
    4
  ],
  "afSetNames": [
    "avoid",
    "custom"
  ]
}
Last updated November 23, 2021.
API Endpoint: