POST api/hire/requestutilisationmobile

Request the utilisation of equipment

Request Information

URI Parameters

None.

Body Parameters

A RequestUtilisationMobileModel

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.
serviceIDList	A list of service ids to be queried	Collection of unsigned integer	None.
startDate	The start date for the query	date	None.
endDate	The end date for the query	date	None.

Request Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "userID": 2,
  "serviceIDList": [
    1,
    2
  ],
  "startDate": "2025-04-27T15:40:31.6740013+00:00",
  "endDate": "2025-04-27T15:40:31.6740013+00:00"
}

application/xml, text/xml

Sample:

<RequestUtilisationMobileModel 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>
  <serviceIDList>
    <unsignedLong>1</unsignedLong>
    <unsignedLong>2</unsignedLong>
  </serviceIDList>
  <startDate>2025-04-27T15:40:31.6740013+00:00</startDate>
  <endDate>2025-04-27T15:40:31.6740013+00:00</endDate>
</RequestUtilisationMobileModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of UtilisationMobileResponseModel objects

Collection of UtilisationMobileResponseModel

Name	Description	Type	Additional information
serviceId	The service id of the unit	unsigned integer	None.
lastOperator	The last operator of the equipment	string	None.
utilisationTime	The time the equipment has been used for in seconds	decimal number	None.
chargeScore	The daily charge score	decimal number	None.
batteryLevel	The last battery level in volts recorded	decimal number	None.
waterUsed	The water used in litres for the current day	decimal number	None.
areaCleaned	The area cleaned for the current day in meters squared	decimal number	None.
lastUsed	The time the unit was last used	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "serviceId": 1,
    "lastOperator": "sample string 2",
    "utilisationTime": 3.1,
    "chargeScore": 4.1,
    "batteryLevel": 5.1,
    "waterUsed": 6.1,
    "areaCleaned": 7.1,
    "lastUsed": "2025-04-27T15:40:31.6740013+00:00"
  },
  {
    "serviceId": 1,
    "lastOperator": "sample string 2",
    "utilisationTime": 3.1,
    "chargeScore": 4.1,
    "batteryLevel": 5.1,
    "waterUsed": 6.1,
    "areaCleaned": 7.1,
    "lastUsed": "2025-04-27T15:40:31.6740013+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUtilisationMobileResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UtilisationMobileResponseModel>
    <serviceId>1</serviceId>
    <lastOperator>sample string 2</lastOperator>
    <utilisationTime>3.1</utilisationTime>
    <chargeScore>4.1</chargeScore>
    <batteryLevel>5.1</batteryLevel>
    <waterUsed>6.1</waterUsed>
    <areaCleaned>7.1</areaCleaned>
    <lastUsed>2025-04-27T15:40:31.6740013+00:00</lastUsed>
  </UtilisationMobileResponseModel>
  <UtilisationMobileResponseModel>
    <serviceId>1</serviceId>
    <lastOperator>sample string 2</lastOperator>
    <utilisationTime>3.1</utilisationTime>
    <chargeScore>4.1</chargeScore>
    <batteryLevel>5.1</batteryLevel>
    <waterUsed>6.1</waterUsed>
    <areaCleaned>7.1</areaCleaned>
    <lastUsed>2025-04-27T15:40:31.6740013+00:00</lastUsed>
  </UtilisationMobileResponseModel>
</ArrayOfUtilisationMobileResponseModel>