MeterReading

Submits a meter reading for specified equipment.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
Request Body schema:
enteredBy
string or null

The name of the person or entity who recorded the reading.

equipmentCode
required
string

The unique equipment code.

readingDate
required
string <date-time>

The effective date of the meter reading.

meterType
required
string (MeterReadingType)

Specifies which type of meter reading is being uses.

Enum: "hourMeter" "odometer"
meterValue
required
integer <int32>

The value of the meter.

bypassValidation
boolean

If true, will bypass certain validation rules such as odometer threshold and hour meter time-elapsed validation.

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

post/api/v1/meterReading
Request samples
{
  • "enteredBy": "John Doe",
  • "equipmentCode": "EX-0003",
  • "readingDate": "2019-03-01T12:05:05Z",
  • "meterType": "hourMeter",
  • "meterValue": 2932,
  • "bypassValidation": false
}
Response samples
application/json
{
  • "id": "03c479db-ecc2-495e-8a10-51de9ddc730a",
  • "enteredBy": "John Doe",
  • "equipmentCode": "EX-0003",
  • "readingDate": "2019-03-01T12:05:05Z",
  • "meterType": "hourMeter",
  • "meterValue": 2932,
  • "bypassValidation": false
}

Gets the latest meter reading.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
businessUnitId
string or null <uuid>

The optional e360 business unit id. If omitted, returns readings in all the business units.

equipmentCode
string or null

The optional equipment code. If omitted, returns reading for all the equipment in the specified business unit.

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/meterReading
Request samples 
Response samples 
application/json
[
  • {
    }
]