POST api/PositionDevices/{id}/Reading

Posts a new Reading for the input Position Device ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The PositionDevice Integer ID

integer

Required

Body Parameters

Payload for the PositionDevice Log to create

PositionPayload
NameDescriptionTypeAdditional information
Fix

Whether or not there was a Fix when this log was made

boolean

None.

Age

Age of the position in seconds

integer

None.

Latitude

Latitude of the position. This is represented as a single decimal value

decimal number

None.

Longitude

Longitude of the position. This is represented as a single decimal value

decimal number

None.

Altitude

Altitude of the position in metres, if available

decimal number

None.

Course

Course as at the position, if available. This is represented as a number of degrees relative to true north

decimal number

None.

Speed

Speed as at the position, if available. This is in km/hr

decimal number

None.

Error

Error of the position, if available. This typically represents the horizontal positional error

decimal number

None.

ReadingDate

Date for the Log to create

date

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Fix": true,
  "Age": 2,
  "Latitude": 1.0,
  "Longitude": 1.0,
  "Altitude": 1.0,
  "Course": 1.0,
  "Speed": 1.0,
  "Error": 1.0,
  "ReadingDate": "2026-01-09T23:54:30.24897+10:00"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PositionPayload'.

Response Information

Resource Description

New log, if created, and any relevant messages

GetPositionDeviceLogResponse
NameDescriptionTypeAdditional information
PositionDevice

The device

PositionDeviceStruct

None.

DeviceLogs

Array of device log entries

Collection of PositionDeviceLog

None.

Messages

Array of messages

Collection of Message

None.

ServerInformation

Relevant information regarding the Server

ServerInformation

None.

VersionInformation

Relevant information regarding the API's version

VersionInformation

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "PositionDevice": {
    "NodeChannel": 1,
    "SerialNumber": "sample string 1",
    "Specifications": "sample string 2",
    "LatestPosition": {
      "Fix": true,
      "Age": 1,
      "Latitude": 2.0,
      "Longitude": 3.0,
      "Altitude": 1.0,
      "Course": 1.0,
      "Speed": 1.0,
      "Error": 1.0,
      "ID": 4,
      "Date": "2026-01-09T23:54:30.24897+10:00",
      "DeviceType": 10
    },
    "ID": 3,
    "Name": "sample string 4",
    "Description": "sample string 5",
    "DataNodeID": 1,
    "DataNodeName": "sample string 6",
    "Category": "sample string 7",
    "Lifespan": 1,
    "ConfiguredAlerts": [
      {
        "ID": 1,
        "Enabled": true,
        "Name": "sample string 3",
        "Description": "sample string 4",
        "AlertType": 0,
        "MaxRepeats": 5,
        "WaitTime": 6,
        "OwnerID": 7,
        "OwnerType": 10,
        "Type": 0,
        "CheckInControlled": true
      },
      {
        "ID": 1,
        "Enabled": true,
        "Name": "sample string 3",
        "Description": "sample string 4",
        "AlertType": 0,
        "MaxRepeats": 5,
        "WaitTime": 6,
        "OwnerID": 7,
        "OwnerType": 10,
        "Type": 0,
        "CheckInControlled": true
      }
    ]
  },
  "DeviceLogs": [
    {
      "Fix": true,
      "Age": 1,
      "Latitude": 2.0,
      "Longitude": 3.0,
      "Altitude": 1.0,
      "Course": 1.0,
      "Speed": 1.0,
      "Error": 1.0,
      "ID": 4,
      "Date": "2026-01-09T23:54:30.24897+10:00",
      "DeviceType": 10
    },
    {
      "Fix": true,
      "Age": 1,
      "Latitude": 2.0,
      "Longitude": 3.0,
      "Altitude": 1.0,
      "Course": 1.0,
      "Speed": 1.0,
      "Error": 1.0,
      "ID": 4,
      "Date": "2026-01-09T23:54:30.24897+10:00",
      "DeviceType": 10
    }
  ],
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2026-01-09T23:54:30.24897+10:00",
    "BuildDateUTC": "2026-01-09T23:54:30.24897+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}