DFHV-api-dev
API change historyRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
All the info needed to create the Trip.
{
"Trip": {
"ExternalID": "string",
"ExternalID2": "string",
"PVIN": "string",
"DecalNumber": "string",
"FacecardID": "string",
"DriverID": "string",
"Type": "Ordinal",
"Rating": 0.0,
"PassengerNum": 0,
"StopNum": 0,
"StartDateTimeUTC": "string",
"EndDateTimeUTC": "string",
"Duration": 0,
"EhailID": "string",
"Milage": 0.0,
"Origin": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"Destination": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"FareAmount": 0.0,
"ExtraFareAmount": 0.0,
"DispatchAmount": 0.0,
"EmergencyAmount": 0.0,
"AirportAmount": 0.0,
"PassengerAmount": 0.0,
"GratuityAmount": 0.0,
"SurchargeAmount": 0.0,
"TollAmount": 0.0,
"TotalAmount": 0.0,
"DiscountAmount": 0.0,
"FareType": "General",
"PaymentType": "Credit",
"Status": "InProgress",
"RiderCode": "string",
"RideRequestCode": "string",
"IsWavRequested": null
},
"ClientID": "string",
"ProviderCode": "string",
"TaxiMeterCode": "string"
}{
"description": "Trip description",
"required": [
"Trip",
"ClientID",
"ProviderCode"
],
"type": "object",
"properties": {
"Trip": {
"description": "The trip.",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
},
"ClientID": {
"description": "The ClientID",
"type": "string"
},
"ProviderCode": {
"description": "The provider that provided the trip",
"type": "string"
},
"TaxiMeterCode": {
"description": "Taxi meter code",
"type": "string"
}
}
}{
"Trip": {
"ExternalID": "string",
"ExternalID2": "string",
"PVIN": "string",
"DecalNumber": "string",
"FacecardID": "string",
"DriverID": "string",
"Type": "Ordinal",
"Rating": 0.0,
"PassengerNum": 0,
"StopNum": 0,
"StartDateTimeUTC": "string",
"EndDateTimeUTC": "string",
"Duration": 0,
"EhailID": "string",
"Milage": 0.0,
"Origin": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"Destination": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"FareAmount": 0.0,
"ExtraFareAmount": 0.0,
"DispatchAmount": 0.0,
"EmergencyAmount": 0.0,
"AirportAmount": 0.0,
"PassengerAmount": 0.0,
"GratuityAmount": 0.0,
"SurchargeAmount": 0.0,
"TollAmount": 0.0,
"TotalAmount": 0.0,
"DiscountAmount": 0.0,
"FareType": "General",
"PaymentType": "Credit",
"Status": "InProgress",
"RiderCode": "string",
"RideRequestCode": "string",
"IsWavRequested": null
},
"ClientID": "string",
"ProviderCode": "string",
"TaxiMeterCode": "string"
}{
"description": "Trip description",
"required": [
"Trip",
"ClientID",
"ProviderCode"
],
"type": "object",
"properties": {
"Trip": {
"description": "The trip.",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
},
"ClientID": {
"description": "The ClientID",
"type": "string"
},
"ProviderCode": {
"description": "The provider that provided the trip",
"type": "string"
},
"TaxiMeterCode": {
"description": "Taxi meter code",
"type": "string"
}
}
}<APITripRequest>
<Trip>
<ExternalID>string</ExternalID>
<ExternalID2>string</ExternalID2>
<PVIN>string</PVIN>
<DecalNumber>string</DecalNumber>
<FacecardID>string</FacecardID>
<DriverID>string</DriverID>
<Type>Ordinal</Type>
<Rating>0</Rating>
<PassengerNum>0</PassengerNum>
<StopNum>0</StopNum>
<StartDateTimeUTC>string</StartDateTimeUTC>
<EndDateTimeUTC>string</EndDateTimeUTC>
<Duration>0</Duration>
<EhailID>string</EhailID>
<Milage>0</Milage>
<Origin>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Origin>
<Destination>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Destination>
<FareAmount>0</FareAmount>
<ExtraFareAmount>0</ExtraFareAmount>
<DispatchAmount>0</DispatchAmount>
<EmergencyAmount>0</EmergencyAmount>
<AirportAmount>0</AirportAmount>
<PassengerAmount>0</PassengerAmount>
<GratuityAmount>0</GratuityAmount>
<SurchargeAmount>0</SurchargeAmount>
<TollAmount>0</TollAmount>
<TotalAmount>0</TotalAmount>
<DiscountAmount>0</DiscountAmount>
<FareType>General</FareType>
<PaymentType>Credit</PaymentType>
<Status>InProgress</Status>
<RiderCode>string</RiderCode>
<RideRequestCode>string</RideRequestCode>
<IsWavRequested></IsWavRequested>
</Trip>
<ClientID>string</ClientID>
<ProviderCode>string</ProviderCode>
<TaxiMeterCode>string</TaxiMeterCode>
</APITripRequest>{
"description": "Trip description",
"required": [
"Trip",
"ClientID",
"ProviderCode"
],
"type": "object",
"properties": {
"Trip": {
"description": "The trip.",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
},
"ClientID": {
"description": "The ClientID",
"type": "string"
},
"ProviderCode": {
"description": "The provider that provided the trip",
"type": "string"
},
"TaxiMeterCode": {
"description": "Taxi meter code",
"type": "string"
}
}
}<APITripRequest>
<Trip>
<ExternalID>string</ExternalID>
<ExternalID2>string</ExternalID2>
<PVIN>string</PVIN>
<DecalNumber>string</DecalNumber>
<FacecardID>string</FacecardID>
<DriverID>string</DriverID>
<Type>Ordinal</Type>
<Rating>0</Rating>
<PassengerNum>0</PassengerNum>
<StopNum>0</StopNum>
<StartDateTimeUTC>string</StartDateTimeUTC>
<EndDateTimeUTC>string</EndDateTimeUTC>
<Duration>0</Duration>
<EhailID>string</EhailID>
<Milage>0</Milage>
<Origin>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Origin>
<Destination>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Destination>
<FareAmount>0</FareAmount>
<ExtraFareAmount>0</ExtraFareAmount>
<DispatchAmount>0</DispatchAmount>
<EmergencyAmount>0</EmergencyAmount>
<AirportAmount>0</AirportAmount>
<PassengerAmount>0</PassengerAmount>
<GratuityAmount>0</GratuityAmount>
<SurchargeAmount>0</SurchargeAmount>
<TollAmount>0</TollAmount>
<TotalAmount>0</TotalAmount>
<DiscountAmount>0</DiscountAmount>
<FareType>General</FareType>
<PaymentType>Credit</PaymentType>
<Status>InProgress</Status>
<RiderCode>string</RiderCode>
<RideRequestCode>string</RideRequestCode>
<IsWavRequested></IsWavRequested>
</Trip>
<ClientID>string</ClientID>
<ProviderCode>string</ProviderCode>
<TaxiMeterCode>string</TaxiMeterCode>
</APITripRequest>{
"description": "Trip description",
"required": [
"Trip",
"ClientID",
"ProviderCode"
],
"type": "object",
"properties": {
"Trip": {
"description": "The trip.",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
},
"ClientID": {
"description": "The ClientID",
"type": "string"
},
"ProviderCode": {
"description": "The provider that provided the trip",
"type": "string"
},
"TaxiMeterCode": {
"description": "Taxi meter code",
"type": "string"
}
}
}Responses
201 Created
Trip registered
Representations
{
"Points": [
{
"Latitude": 0.0,
"Longitude": 0.0,
"Timestamp": "string"
}
],
"ID": "string",
"ExternalID": "string",
"ExternalID2": "string",
"PVIN": "string",
"DecalNumber": "string",
"FacecardID": "string",
"DriverID": "string",
"Type": "Ordinal",
"Rating": 0.0,
"PassengerNum": 0,
"StopNum": 0,
"StartDateTimeUTC": "string",
"EndDateTimeUTC": "string",
"Duration": 0,
"EhailID": "string",
"Milage": 0.0,
"Origin": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"Destination": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"FareAmount": 0.0,
"ExtraFareAmount": 0.0,
"DispatchAmount": 0.0,
"EmergencyAmount": 0.0,
"AirportAmount": 0.0,
"PassengerAmount": 0.0,
"GratuityAmount": 0.0,
"SurchargeAmount": 0.0,
"TollAmount": 0.0,
"TotalAmount": 0.0,
"DiscountAmount": 0.0,
"FareType": "General",
"PaymentType": "Credit",
"Status": "InProgress",
"RiderCode": "string",
"RideRequestCode": "string",
"IsWavRequested": null
}{
"description": "Trip Information Entity extended with Geo data",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"Points": {
"description": "Ordered collection of trip location points",
"type": "array",
"items": {
"description": "Geographical coordinates",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "Timestamp",
"type": "string"
}
}
}
},
"ID": {
"description": "Gets the identifier.",
"type": "string"
},
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
}{
"Points": [
{
"Latitude": 0.0,
"Longitude": 0.0,
"Timestamp": "string"
}
],
"ID": "string",
"ExternalID": "string",
"ExternalID2": "string",
"PVIN": "string",
"DecalNumber": "string",
"FacecardID": "string",
"DriverID": "string",
"Type": "Ordinal",
"Rating": 0.0,
"PassengerNum": 0,
"StopNum": 0,
"StartDateTimeUTC": "string",
"EndDateTimeUTC": "string",
"Duration": 0,
"EhailID": "string",
"Milage": 0.0,
"Origin": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"Destination": {
"FullText": "string",
"StreetNumber": "string",
"StreetName": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Extra": "string",
"Latitude": 0.0,
"Longitude": 0.0
},
"FareAmount": 0.0,
"ExtraFareAmount": 0.0,
"DispatchAmount": 0.0,
"EmergencyAmount": 0.0,
"AirportAmount": 0.0,
"PassengerAmount": 0.0,
"GratuityAmount": 0.0,
"SurchargeAmount": 0.0,
"TollAmount": 0.0,
"TotalAmount": 0.0,
"DiscountAmount": 0.0,
"FareType": "General",
"PaymentType": "Credit",
"Status": "InProgress",
"RiderCode": "string",
"RideRequestCode": "string",
"IsWavRequested": null
}{
"description": "Trip Information Entity extended with Geo data",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"Points": {
"description": "Ordered collection of trip location points",
"type": "array",
"items": {
"description": "Geographical coordinates",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "Timestamp",
"type": "string"
}
}
}
},
"ID": {
"description": "Gets the identifier.",
"type": "string"
},
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
}<APITripExtended>
<Points>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Timestamp>string</Timestamp>
</Points>
<ID>string</ID>
<ExternalID>string</ExternalID>
<ExternalID2>string</ExternalID2>
<PVIN>string</PVIN>
<DecalNumber>string</DecalNumber>
<FacecardID>string</FacecardID>
<DriverID>string</DriverID>
<Type>Ordinal</Type>
<Rating>0</Rating>
<PassengerNum>0</PassengerNum>
<StopNum>0</StopNum>
<StartDateTimeUTC>string</StartDateTimeUTC>
<EndDateTimeUTC>string</EndDateTimeUTC>
<Duration>0</Duration>
<EhailID>string</EhailID>
<Milage>0</Milage>
<Origin>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Origin>
<Destination>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Destination>
<FareAmount>0</FareAmount>
<ExtraFareAmount>0</ExtraFareAmount>
<DispatchAmount>0</DispatchAmount>
<EmergencyAmount>0</EmergencyAmount>
<AirportAmount>0</AirportAmount>
<PassengerAmount>0</PassengerAmount>
<GratuityAmount>0</GratuityAmount>
<SurchargeAmount>0</SurchargeAmount>
<TollAmount>0</TollAmount>
<TotalAmount>0</TotalAmount>
<DiscountAmount>0</DiscountAmount>
<FareType>General</FareType>
<PaymentType>Credit</PaymentType>
<Status>InProgress</Status>
<RiderCode>string</RiderCode>
<RideRequestCode>string</RideRequestCode>
<IsWavRequested></IsWavRequested>
</APITripExtended>{
"description": "Trip Information Entity extended with Geo data",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"Points": {
"description": "Ordered collection of trip location points",
"type": "array",
"items": {
"description": "Geographical coordinates",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "Timestamp",
"type": "string"
}
}
}
},
"ID": {
"description": "Gets the identifier.",
"type": "string"
},
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
}<APITripExtended>
<Points>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Timestamp>string</Timestamp>
</Points>
<ID>string</ID>
<ExternalID>string</ExternalID>
<ExternalID2>string</ExternalID2>
<PVIN>string</PVIN>
<DecalNumber>string</DecalNumber>
<FacecardID>string</FacecardID>
<DriverID>string</DriverID>
<Type>Ordinal</Type>
<Rating>0</Rating>
<PassengerNum>0</PassengerNum>
<StopNum>0</StopNum>
<StartDateTimeUTC>string</StartDateTimeUTC>
<EndDateTimeUTC>string</EndDateTimeUTC>
<Duration>0</Duration>
<EhailID>string</EhailID>
<Milage>0</Milage>
<Origin>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Origin>
<Destination>
<FullText>string</FullText>
<StreetNumber>string</StreetNumber>
<StreetName>string</StreetName>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
<Extra>string</Extra>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
</Destination>
<FareAmount>0</FareAmount>
<ExtraFareAmount>0</ExtraFareAmount>
<DispatchAmount>0</DispatchAmount>
<EmergencyAmount>0</EmergencyAmount>
<AirportAmount>0</AirportAmount>
<PassengerAmount>0</PassengerAmount>
<GratuityAmount>0</GratuityAmount>
<SurchargeAmount>0</SurchargeAmount>
<TollAmount>0</TollAmount>
<TotalAmount>0</TotalAmount>
<DiscountAmount>0</DiscountAmount>
<FareType>General</FareType>
<PaymentType>Credit</PaymentType>
<Status>InProgress</Status>
<RiderCode>string</RiderCode>
<RideRequestCode>string</RideRequestCode>
<IsWavRequested></IsWavRequested>
</APITripExtended>{
"description": "Trip Information Entity extended with Geo data",
"required": [
"ExternalID",
"StartDateTimeUTC"
],
"type": "object",
"properties": {
"Points": {
"description": "Ordered collection of trip location points",
"type": "array",
"items": {
"description": "Geographical coordinates",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "Timestamp",
"type": "string"
}
}
}
},
"ID": {
"description": "Gets the identifier.",
"type": "string"
},
"ExternalID": {
"description": "External ID of the Trip",
"type": "string"
},
"ExternalID2": {
"description": "External ID2 of the Trip",
"type": "string"
},
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"DecalNumber": {
"description": "DecalNumber of the vehicle",
"type": "string"
},
"FacecardID": {
"description": "Facecard ID of the driver",
"type": "string"
},
"DriverID": {
"description": "DriverID of the driver",
"type": "string"
},
"Type": {
"description": "The Trip type (i.e. Ordinal, Transport DC, VoD)",
"enum": [
"Ordinal",
"VoD",
"TransportDC",
"TransportDCShared",
"MOVA",
"CFSA",
"NRS",
"NEMT"
],
"type": "string"
},
"Rating": {
"format": "double",
"description": "The Trip rating.",
"type": "number"
},
"PassengerNum": {
"format": "int32",
"description": "Number of passengers",
"type": "integer"
},
"StopNum": {
"format": "int32",
"description": "Number of stops",
"type": "integer"
},
"StartDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip started in UTC",
"type": "string"
},
"EndDateTimeUTC": {
"format": "date-time",
"description": "Timestamp when the Trip ended in UTC",
"type": "string"
},
"Duration": {
"format": "int32",
"description": "Duration of the trip in seconds",
"type": "integer"
},
"EhailID": {
"description": "eHail ID associated with the trip (optional)",
"type": "string"
},
"Milage": {
"format": "double",
"description": "Mileage of the trip in miles",
"type": "number"
},
"Origin": {
"description": "Origin of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"Destination": {
"description": "Destination of the trip",
"required": [
"Latitude",
"Longitude"
],
"type": "object",
"properties": {
"FullText": {
"description": "Full address",
"type": "string"
},
"StreetNumber": {
"description": "Street address",
"type": "string"
},
"StreetName": {
"description": "Street address",
"type": "string"
},
"City": {
"description": "Adress city",
"type": "string"
},
"State": {
"description": "Address state",
"type": "string"
},
"Zip": {
"description": "Address zip code",
"type": "string"
},
"Extra": {
"description": "Extra address information",
"type": "string"
},
"Latitude": {
"format": "double",
"description": "Latitude",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "Longitude",
"type": "number"
}
}
},
"FareAmount": {
"format": "double",
"description": "The fare amount",
"type": "number"
},
"ExtraFareAmount": {
"format": "double",
"description": "The extra fare amount",
"type": "number"
},
"DispatchAmount": {
"format": "double",
"description": "The dispatch amount",
"type": "number"
},
"EmergencyAmount": {
"format": "double",
"description": "The emergency amount",
"type": "number"
},
"AirportAmount": {
"format": "double",
"description": "The airport amount",
"type": "number"
},
"PassengerAmount": {
"format": "double",
"description": "The passenger amount",
"type": "number"
},
"GratuityAmount": {
"format": "double",
"description": "The gratuity amount",
"type": "number"
},
"SurchargeAmount": {
"format": "double",
"description": "The surcharge amount",
"type": "number"
},
"TollAmount": {
"format": "double",
"description": "The toll amount",
"type": "number"
},
"TotalAmount": {
"format": "double",
"description": "The total amount",
"type": "number"
},
"DiscountAmount": {
"format": "double",
"description": "The discount amount",
"type": "number"
},
"FareType": {
"description": "The fare type (General, Shared, Flat, Hourly)",
"enum": [
"General",
"Shared",
"Hourly",
"Flat"
],
"type": "string"
},
"PaymentType": {
"description": "The payment type",
"enum": [
"Credit",
"Cash",
"EHail",
"Other",
"Uber"
],
"type": "string"
},
"Status": {
"description": "The status of the trip.",
"enum": [
"InProgress",
"Pending",
"Completed",
"Canceled"
],
"type": "string"
},
"RiderCode": {
"description": "The rider code.",
"type": "string"
},
"RideRequestCode": {
"description": "Ride request identificator. 4 characters alphanumeric code.",
"type": "string"
},
"IsWavRequested": {
"description": "Denotes if WAV was requested. Expected values: true/false or null (default) if not applicable.",
"type": [
"boolean",
"null"
],
"default": null
}
}
}400 Bad Request
Wrong model
Representations
{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}401 Unauthorized
The client/meter/provider is not authorized
Representations
{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}500 Internal Server Error
When there is an error on the server side
Representations
{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}{
"ErrorCode": "Unknown",
"Message": "string"
}{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}<APIGenericError>
<ErrorCode>Unknown</ErrorCode>
<Message>string</Message>
</APIGenericError>{
"description": "Generic Error description",
"type": "object",
"properties": {
"ErrorCode": {
"description": "The error code",
"enum": [
"Unknown",
"ServerError",
"BadRequest",
"InvalidClient",
"InvalidProvider",
"NotFound",
"AlreadyExists",
"InvalidTaxiMeter"
],
"type": "string"
},
"Message": {
"description": "The message",
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X POST "https://dfhv-api.terraiq.io/dev/v2/api/trips"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://dfhv-api.terraiq.io/dev/v2/api/trips?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://dfhv-api.terraiq.io/dev/v2/api/trips");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://dfhv-api.terraiq.io/dev/v2/api/trips?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://dfhv-api.terraiq.io/dev/v2/api/trips";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://dfhv-api.terraiq.io/dev/v2/api/trips');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('dfhv-api.terraiq.io')
conn.request("POST", "/dev/v2/api/trips?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('dfhv-api.terraiq.io')
conn.request("POST", "/dev/v2/api/trips?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://dfhv-api.terraiq.io/dev/v2/api/trips')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body