GET api/Positions/GetById?SerialNumber={SerialNumber}&PositionId={PositionId}

Get a specific position for a unit.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SerialNumber

Unit serial number

string

Required

PositionId

Unit's position id

integer64

Required

Body Parameters

None.

Response Information

Resource Description

Get a specific position for a unit.

PositionModel
NameDescriptionTypeAdditional information
Id

integer64

Required

SerialNumber

string

Required

ReferenceId

Unit's referenceId

string

None.

Timestamp

Timestamp in UTC

date

None.

Latitude

decimal number

None.

Longitude

decimal number

None.

Accuracy

Acuracy in meters

integer32

None.

Speed

Speed in km/h

decimal number

Null values possible.

Altitude

Altitude in meters

decimal number

Null values possible.

Heading

Heading in degrees

decimal number

Null values possible.

Trigger

Flags.

UnitReportTriggerEnum

None.

PositionType

PositionTypeEnum

None.

GSMNetwork

2G, 3G, 4G

string

None.

ServingCell

MobileCellModel

Null values possible.

NeighbourCells

Collection of MobileCellModel

None.

Location

Location (if any)

LocationModel

Null values possible.

MessageId

integer64

None.

ServerDate

Timestamp for message received at server

date

None.

IsLog

Indicates if this position originates from a log message

boolean

None.

IsSMS

Indicates if this position originates from an SMS transmission

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "SerialNumber": "sample string 2",
  "ReferenceId": "sample string 3",
  "Timestamp": "2024-05-19T15:58:21.8634865+00:00",
  "Latitude": 5.1,
  "Longitude": 6.1,
  "Accuracy": 7,
  "Speed": 1.0,
  "Altitude": 1.0,
  "Heading": 1.0,
  "Trigger": 0,
  "PositionType": 0,
  "GSMNetwork": "sample string 8",
  "ServingCell": {
    "MobileCountryCode": 2,
    "MobileNetworkCode": 3,
    "LocationAreaCode": 4,
    "CellId": 5,
    "Signal": 6,
    "CellType": "sample string 7",
    "TimeAdvance": 1
  },
  "NeighbourCells": [
    {
      "MobileCountryCode": 2,
      "MobileNetworkCode": 3,
      "LocationAreaCode": 4,
      "CellId": 5,
      "Signal": 6,
      "CellType": "sample string 7",
      "TimeAdvance": 1
    },
    {
      "MobileCountryCode": 2,
      "MobileNetworkCode": 3,
      "LocationAreaCode": 4,
      "CellId": 5,
      "Signal": 6,
      "CellType": "sample string 7",
      "TimeAdvance": 1
    }
  ],
  "Location": null,
  "MessageId": 9,
  "ServerDate": "2024-05-19T15:58:21.8634865+00:00",
  "IsLog": true,
  "IsSMS": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.