GET api/v4/passengercount/{userID}/{token}/{serviceID}/{from}/{to}
Pulls back passenger count records - Maps to V3 GetPassengerCount web service method
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
The ID returned from a successful login |
unsigned integer |
Required |
token |
The authentication token returned from a successful login |
string |
Required |
serviceID |
The service id of the vehicle being queried |
unsigned integer |
Required |
from |
The start date being queried yyyyMMddHHmmss |
string |
Required |
to |
The end date being queried yyyyMMddHHmmss |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of passenger counts
Collection of PassengerCountName | Description | Type | Additional information |
---|---|---|---|
ServiceId |
The service id of the vehicle |
unsigned integer |
None. |
StartTimestamp |
The start time of the journey |
date |
None. |
EndTimestamp |
The end time of the journey |
date |
None. |
SysMsgType |
The message type |
integer |
None. |
StartCount |
The start passenger count |
integer |
None. |
InCount |
The in passenger count |
integer |
None. |
OutCount |
The out passenger count |
integer |
None. |
EndCount |
The end passenger count |
integer |
None. |
MeanCount |
The average passenger count |
decimal number |
None. |
PassengerDist |
The passenger distance |
decimal number |
None. |
DoorCount |
The number of times the doors were opened |
integer |
None. |
Response Formats
application/json, text/json
[ { "ServiceId": 1, "StartTimestamp": "2025-04-27T15:25:30.7172069+00:00", "EndTimestamp": "2025-04-27T15:25:30.7172069+00:00", "SysMsgType": 4, "StartCount": 5, "InCount": 6, "OutCount": 7, "EndCount": 8, "MeanCount": 9.1, "PassengerDist": 10.1, "DoorCount": 11 }, { "ServiceId": 1, "StartTimestamp": "2025-04-27T15:25:30.7172069+00:00", "EndTimestamp": "2025-04-27T15:25:30.7172069+00:00", "SysMsgType": 4, "StartCount": 5, "InCount": 6, "OutCount": 7, "EndCount": 8, "MeanCount": 9.1, "PassengerDist": 10.1, "DoorCount": 11 } ]
application/xml, text/xml
<ArrayOfPassengerCount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PassengerCount> <ServiceId>1</ServiceId> <StartTimestamp>2025-04-27T15:25:30.7172069+00:00</StartTimestamp> <EndTimestamp>2025-04-27T15:25:30.7172069+00:00</EndTimestamp> <SysMsgType>4</SysMsgType> <StartCount>5</StartCount> <InCount>6</InCount> <OutCount>7</OutCount> <EndCount>8</EndCount> <MeanCount>9.1</MeanCount> <PassengerDist>10.1</PassengerDist> <DoorCount>11</DoorCount> </PassengerCount> <PassengerCount> <ServiceId>1</ServiceId> <StartTimestamp>2025-04-27T15:25:30.7172069+00:00</StartTimestamp> <EndTimestamp>2025-04-27T15:25:30.7172069+00:00</EndTimestamp> <SysMsgType>4</SysMsgType> <StartCount>5</StartCount> <InCount>6</InCount> <OutCount>7</OutCount> <EndCount>8</EndCount> <MeanCount>9.1</MeanCount> <PassengerDist>10.1</PassengerDist> <DoorCount>11</DoorCount> </PassengerCount> </ArrayOfPassengerCount>