POST api/hirev2/requestutilisationv2

Request the utilisation of equipment

Request Information

URI Parameters

None.

Body Parameters

A RequestUtilisationModel

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.
startDate	The start date for the query	date	None.
endDate	The end date for the query	date	None.
equipmentList	A list of equipment to be queried	Collection of RequestUtilisationV2EquipmentModel	None.

Request Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "userID": 2,
  "startDate": "2025-04-27T15:29:13.5396942+00:00",
  "endDate": "2025-04-27T15:29:13.5396942+00:00",
  "equipmentList": [
    {
      "serviceID": 1,
      "ecode": "sample string 2",
      "commCode": "sample string 3"
    },
    {
      "serviceID": 1,
      "ecode": "sample string 2",
      "commCode": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<RequestUtilisationV2Model 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>
  <startDate>2025-04-27T15:29:13.5396942+00:00</startDate>
  <endDate>2025-04-27T15:29:13.5396942+00:00</endDate>
  <equipmentList>
    <RequestUtilisationV2EquipmentModel>
      <serviceID>1</serviceID>
      <ecode>sample string 2</ecode>
      <commCode>sample string 3</commCode>
    </RequestUtilisationV2EquipmentModel>
    <RequestUtilisationV2EquipmentModel>
      <serviceID>1</serviceID>
      <ecode>sample string 2</ecode>
      <commCode>sample string 3</commCode>
    </RequestUtilisationV2EquipmentModel>
  </equipmentList>
</RequestUtilisationV2Model>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A UtilisationResponseModel

Collection of UtilisationResponseV2Model

Name	Description	Type	Additional information
serviceID	The service id of the equipment	unsigned integer	None.
ecode	The ecode used to identify equipment	string	None.
commCode	The comm code used to identify equipment	string	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.

Response Formats

application/json, text/json

Sample:

[
  {
    "serviceID": 1,
    "ecode": "sample string 2",
    "commCode": "sample string 3",
    "lastOperator": "sample string 4",
    "utilisationTime": 5.1,
    "chargeScore": 6.1,
    "batteryLevel": 7.1,
    "waterUsed": 8.1,
    "areaCleaned": 9.1
  },
  {
    "serviceID": 1,
    "ecode": "sample string 2",
    "commCode": "sample string 3",
    "lastOperator": "sample string 4",
    "utilisationTime": 5.1,
    "chargeScore": 6.1,
    "batteryLevel": 7.1,
    "waterUsed": 8.1,
    "areaCleaned": 9.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfUtilisationResponseV2Model xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UtilisationResponseV2Model>
    <serviceID>1</serviceID>
    <ecode>sample string 2</ecode>
    <commCode>sample string 3</commCode>
    <lastOperator>sample string 4</lastOperator>
    <utilisationTime>5.1</utilisationTime>
    <chargeScore>6.1</chargeScore>
    <batteryLevel>7.1</batteryLevel>
    <waterUsed>8.1</waterUsed>
    <areaCleaned>9.1</areaCleaned>
  </UtilisationResponseV2Model>
  <UtilisationResponseV2Model>
    <serviceID>1</serviceID>
    <ecode>sample string 2</ecode>
    <commCode>sample string 3</commCode>
    <lastOperator>sample string 4</lastOperator>
    <utilisationTime>5.1</utilisationTime>
    <chargeScore>6.1</chargeScore>
    <batteryLevel>7.1</batteryLevel>
    <waterUsed>8.1</waterUsed>
    <areaCleaned>9.1</areaCleaned>
  </UtilisationResponseV2Model>
</ArrayOfUtilisationResponseV2Model>