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

Request Fields

FieldDescriptionTypeRequired
tripIdThe alkTripId returned when you planned the trip.integerYes

GET /trip/avoidFavors?tripId={tripId}

Request Fields

FieldDescriptionTypeRequired
tripIdThe 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 stringYes

Response Fields

Same response for both the types of requests

FieldDescriptionType
tripIdThe trip identifier.integer
afSetIdsAn array of avoid favor set ids.Array <integer>
afSetNamesAn array of avoid favor set names.Array <string>

Example

Sample Response

{
  "tripId": 410602,
  "afSetIds": [
    2,
    3,
    4
  ],
  "afSetNames": [
    "avoid",
    "custom"
  ]
}