POST api/hire/servicestatuslite

Request service status - Service id takes priority in searches

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
token	The token returned after login used for authentication	string	None.
userID	The userid returned after login used for authentication	unsigned integer	None.
serviceID	The service id of the service status we are interested in	unsigned integer	None.
groupID	If no service status is requested the request will be made based on group id	unsigned integer	None.

Request Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "userID": 2,
  "serviceID": 3,
  "groupID": 4
}

application/xml, text/xml

Sample:

<RequestServiceStatusLiteModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <token>sample string 1</token>
  <userID>2</userID>
  <serviceID>3</serviceID>
  <groupID>4</groupID>
</RequestServiceStatusLiteModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of ServiceStatusLiteResponseModel

Collection of ServiceStatusLiteResponseModel

Name	Description	Type	Additional information
serviceID	The service id of the vehicle	unsigned integer	None.
vehicleRegistration	The vehicles registration	string	None.
vehicleIcon	The vehicles icon on the web site	string	None.
geoStreet	The street the vehicle is currently located in	string	None.
geoTown	The town the vehicle is currently located in	string	None.
geoCountry	The country the vehicle is currently located in	string	None.
geoPostCode	The postcode the vehicle is currently located in	string	None.
gpsLatitude	The vehicle's current latitude	decimal number	None.
gpsLongitude	The vehicle's current longitude	decimal number	None.
gpsTime	The last update time of the vehicle	date	None.
serviceFlags	ServiceDataFlags flags indicating the state of a vehicles inputs	ServiceDataFlags	None.
VIN	The vehicle identification number	string	None.
USDOT	The USDOT value	string	None.
Voltage	The last voltage	decimal number	None.
Status	The status	string	None.
StatusUpdateDate	When the status was changed	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "serviceID": 1,
    "vehicleRegistration": "sample string 2",
    "vehicleIcon": "sample string 3",
    "geoStreet": "sample string 4",
    "geoTown": "sample string 5",
    "geoCountry": "sample string 6",
    "geoPostCode": "sample string 7",
    "gpsLatitude": 8.1,
    "gpsLongitude": 9.1,
    "gpsTime": "2025-04-27T16:50:13.5816442+00:00",
    "serviceFlags": 1,
    "VIN": "sample string 11",
    "USDOT": "sample string 12",
    "Voltage": 13.1,
    "Status": "sample string 15",
    "StatusUpdateDate": "2025-04-27T16:50:13.5816442+00:00"
  },
  {
    "serviceID": 1,
    "vehicleRegistration": "sample string 2",
    "vehicleIcon": "sample string 3",
    "geoStreet": "sample string 4",
    "geoTown": "sample string 5",
    "geoCountry": "sample string 6",
    "geoPostCode": "sample string 7",
    "gpsLatitude": 8.1,
    "gpsLongitude": 9.1,
    "gpsTime": "2025-04-27T16:50:13.5816442+00:00",
    "serviceFlags": 1,
    "VIN": "sample string 11",
    "USDOT": "sample string 12",
    "Voltage": 13.1,
    "Status": "sample string 15",
    "StatusUpdateDate": "2025-04-27T16:50:13.5816442+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfServiceStatusLiteResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceStatusLiteResponseModel>
    <serviceID>1</serviceID>
    <vehicleRegistration>sample string 2</vehicleRegistration>
    <vehicleIcon>sample string 3</vehicleIcon>
    <geoStreet>sample string 4</geoStreet>
    <geoTown>sample string 5</geoTown>
    <geoCountry>sample string 6</geoCountry>
    <geoPostCode>sample string 7</geoPostCode>
    <gpsLatitude>8.1</gpsLatitude>
    <gpsLongitude>9.1</gpsLongitude>
    <gpsTime>2025-04-27T16:50:13.5816442+00:00</gpsTime>
    <serviceFlags>Ignition</serviceFlags>
    <VIN>sample string 11</VIN>
    <USDOT>sample string 12</USDOT>
    <Voltage>13.1</Voltage>
    <StatusInt>14</StatusInt>
    <Status>sample string 15</Status>
    <StatusUpdateDate>2025-04-27T16:50:13.5816442+00:00</StatusUpdateDate>
  </ServiceStatusLiteResponseModel>
  <ServiceStatusLiteResponseModel>
    <serviceID>1</serviceID>
    <vehicleRegistration>sample string 2</vehicleRegistration>
    <vehicleIcon>sample string 3</vehicleIcon>
    <geoStreet>sample string 4</geoStreet>
    <geoTown>sample string 5</geoTown>
    <geoCountry>sample string 6</geoCountry>
    <geoPostCode>sample string 7</geoPostCode>
    <gpsLatitude>8.1</gpsLatitude>
    <gpsLongitude>9.1</gpsLongitude>
    <gpsTime>2025-04-27T16:50:13.5816442+00:00</gpsTime>
    <serviceFlags>Ignition</serviceFlags>
    <VIN>sample string 11</VIN>
    <USDOT>sample string 12</USDOT>
    <Voltage>13.1</Voltage>
    <StatusInt>14</StatusInt>
    <Status>sample string 15</Status>
    <StatusUpdateDate>2025-04-27T16:50:13.5816442+00:00</StatusUpdateDate>
  </ServiceStatusLiteResponseModel>
</ArrayOfServiceStatusLiteResponseModel>