GET api/v{version}/clients/{clientId}/trips/{bookingId}/externalId

Gets the external TNC ride identifiers recorded against a trip, so a will call can be activated directly with the vendor.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The ID of the client that the trip belongs to.	integer	Required
bookingId	The ID of the booking that we're looking for.	integer	Required
version	The requested API version	string	Required Default value is 2.0

Name

Description

Type

Additional information

clientId

The ID of the client that the trip belongs to.

integer

Required

bookingId

The ID of the booking that we're looking for.

integer

Required

version

The requested API version

string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns the TNC ride ids and vendor. Either id may be null; a trip that is not handled by a TNC returns nulls rather than an error.

TripExternalId

Name	Description	Type	Additional information
ExternalId	The active/dispatched TNC ride id, or null when there isn't one.	string	None.
FlexExternalId	The flex / will-call TNC ride id, or null when there isn't one.	string	None.
Vendor	The TNC handling the trip.	TncVendor	None.
RideStatus	Best-effort status of the active ride, or null. Populated only by NOVUS's live vendor enrichment, so it is null whenever the TNC vendor is unreachable. A null status does NOT mean there is no ride - only says that. A non-null value does NOT imply a TNC ride, because a non-TNC export integration can also set it.	string	None.
FlexRideStatus	Best-effort status of the flex / will-call ride, or null. Populated only while the ride is still un-activated: once the ride is activated this is always null even though still holds a value. Never treat null as "no flex ride".	string	None.

Response Formats

application/json, text/json, application/problem+json

Sample:

{
  "externalId": "sample string 1",
  "flexExternalId": "sample string 2",
  "vendor": 0,
  "rideStatus": "sample string 3",
  "flexRideStatus": "sample string 4"
}

application/xml, text/xml

Sample:

<TripExternalId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ExternalId>sample string 1</ExternalId>
  <FlexExternalId>sample string 2</FlexExternalId>
  <FlexRideStatus>sample string 4</FlexRideStatus>
  <RideStatus>sample string 3</RideStatus>
  <Vendor>Unknown</Vendor>
</TripExternalId>