GET api/clients/{clientID}/tripsCount?startMonth={startMonth}&monthsCount={monthsCount}
Gets the trips count for a client within the given date range.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientID |
ID of the client to get the trips for. |
integer |
Required |
startMonth |
The date to pull the month and year from to get the trip count for, starting from 1st. |
date |
None. |
monthsCount |
Number of months to add in to the start month to get the trip counts for. |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
Collection of TripCountInfoName | Description | Type | Additional information |
---|---|---|---|
Date |
The date. |
date |
None. |
ScheduledTripsCount |
Gets or sets the number of scheduled trips. |
integer |
None. |
UnscheduledTripsCount |
Gets or sets the number of Unscheduled trips. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "date": "2024-12-23T12:09:57.8123895-07:00", "scheduledTripsCount": 2, "unscheduledTripsCount": 3 }, { "date": "2024-12-23T12:09:57.8123895-07:00", "scheduledTripsCount": 2, "unscheduledTripsCount": 3 } ]
application/xml, text/xml
Sample:
<ArrayOfTripCountInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <TripCountInfo> <Date>2024-12-23T12:09:57.8123895-07:00</Date> <ScheduledTripsCount>2</ScheduledTripsCount> <UnscheduledTripsCount>3</UnscheduledTripsCount> </TripCountInfo> <TripCountInfo> <Date>2024-12-23T12:09:57.8123895-07:00</Date> <ScheduledTripsCount>2</ScheduledTripsCount> <UnscheduledTripsCount>3</UnscheduledTripsCount> </TripCountInfo> </ArrayOfTripCountInfo>