PUT api/PositionDevices

Update the information for a specific Position Device

Request Information

URI Parameters

None.

Body Parameters

Updated Position Device information to use

Name	Type	Additional information
NodeChannel	integer	None.
SerialNumber	string	None.
Specifications	string	None.
ID	integer	None.
Name	string	None.
Description	string	None.
DataNodeID	integer	None.
Category	string	None.
Lifespan	integer	None.
ConfiguredAlerts	Collection of AddUpdate_ConfiguredAlert	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "NodeChannel": 1,
  "SerialNumber": "sample string 2",
  "Specifications": "sample string 3",
  "ID": 4,
  "Name": "sample string 5",
  "Description": "sample string 6",
  "DataNodeID": 1,
  "Category": "sample string 7",
  "Lifespan": 1,
  "ConfiguredAlerts": [
    {
      "ID": 1,
      "Enabled": true,
      "OwnerID": 1,
      "OwnerType": 10,
      "AlertType": 0,
      "MaxRepeats": 1,
      "WaitTime": 1,
      "Type": 0,
      "CheckInControlled": true,
      "Name": "sample string 3",
      "Description": "sample string 4"
    },
    {
      "ID": 1,
      "Enabled": true,
      "OwnerID": 1,
      "OwnerType": 10,
      "AlertType": 0,
      "MaxRepeats": 1,
      "WaitTime": 1,
      "Type": 0,
      "CheckInControlled": true,
      "Name": "sample string 3",
      "Description": "sample string 4"
    }
  ]
}

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 'Update_PositionDevice'.

Response Information

Resource Description

Updated Position Device and any relevant messages

GetPositionDevicesResponse

Name	Description	Type	Additional information
PositionDevices	Array of PositionDevice	Collection of PositionDeviceStruct	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:

{
  "PositionDevices": [
    {
      "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:44:38.3074695+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
        }
      ]
    },
    {
      "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:44:38.3074695+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
        }
      ]
    }
  ],
  "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:44:38.3074695+10:00",
    "BuildDateUTC": "2026-01-09T23:44:38.3074695+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}