GET api/Messages/Unread?limit={limit}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Message
NameDescriptionTypeAdditional information
MessageId

integer

None.

IsRead

boolean

None.

Content

string

None.

Location

Location

None.

Recipient

User

None.

IsHighPriority

boolean

None.

SentDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "MessageId": 1,
    "IsRead": true,
    "Content": "sample string 3",
    "Location": {
      "$id": "2",
      "Latitude": 1.1,
      "Longitude": 2.1,
      "AreaName": "sample string 2, sample string 2"
    },
    "Recipient": {
      "$id": "3",
      "UserId": 1,
      "DriverId": "sample string 2",
      "Login": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "Company": {
        "$id": "4",
        "CompanyId": 1,
        "CompanyName": "sample string 2",
        "CompanyUrl": "sample string 3",
        "LogoUrl": "sample string 4",
        "IsActive": true
      },
      "Creator": {
        "$ref": "3"
      },
      "Calendar": {
        "$id": "5",
        "CalendarId": 1,
        "CalendarName": "sample string 2"
      },
      "EmailAddress": "sample string 7",
      "PhoneNumber": "sample string 8",
      "TrackingObjectGroups": [
        {
          "$id": "6",
          "TrackingObjectGroupId": 1,
          "TrackingObjectGroupName": "sample string 2",
          "Description": "sample string 3",
          "Company": {
            "$ref": "4"
          },
          "Users": [
            {
              "$ref": "3"
            },
            {
              "$ref": "3"
            }
          ],
          "TrackingObjects": [
            {
              "$id": "7",
              "TrackingObjectId": 1,
              "TrackingObjectName": "sample string 2",
              "Company": {
                "$ref": "4"
              },
              "Device": {
                "$id": "8",
                "DeviceId": 1,
                "SenderId": "sample string 2",
                "InstalledSIMCard": {
                  "$id": "9",
                  "SIMCardId": 1,
                  "SerialNumber": "sample string 2",
                  "AddressIP": "sample string 3",
                  "PIN": "sample string 4",
                  "PUK": "sample string 5",
                  "PhoneNumber": "sample string 6",
                  "ActivationDate": "2026-02-02T19:51:09.4106936+01:00",
                  "ExpirationDate": "2026-02-02T19:51:09.4106936+01:00",
                  "Device": {
                    "$ref": "8"
                  }
                },
                "Model": "sample string 3",
                "SerialNumber": "sample string 5",
                "IsActive": true,
                "CAN": true,
                "DeviceFeatures": 1,
                "DeviceType": 0,
                "TrackingObject": {
                  "$ref": "7"
                }
              },
              "Driver": {
                "$ref": "3"
              },
              "TrackingObjectGroups": [
                {
                  "$ref": "6"
                },
                {
                  "$ref": "6"
                }
              ],
              "IsActive": true,
              "Note": "sample string 4",
              "Tank": {
                "$id": "10",
                "TankId": 1,
                "TankName": "sample string 2",
                "Capacity": 3,
                "Ratio": 64,
                "Threshold": 5.1,
                "Lag": 6,
                "Measures": [
                  {
                    "$id": "11",
                    "MeasureId": 1,
                    "Input": 2.1,
                    "Output": 3.1
                  },
                  {
                    "$ref": "11"
                  }
                ],
                "Inputs": [
                  {
                    "$id": "12",
                    "TankInputId": 1,
                    "AnalogInput": 2,
                    "Coefficient": 3.1,
                    "InputIndex": 1
                  },
                  {
                    "$ref": "12"
                  }
                ],
                "ToleranceDefueling": 7.1,
                "ToleranceFuelLevel": 8.1,
                "InputIndex": 9,
                "IsIgnoreEngineStatus": true
              },
              "TankDate": "2026-02-02T19:51:09.4106936+01:00",
              "RegistrationNumber": "sample string 5",
              "MakeModel": "sample string 7 sample string 6",
              "Model": "sample string 6",
              "Manufacturer": "sample string 7",
              "InitialOdometerValue": 1,
              "ReportsOdometer": true,
              "SpeedLimit": 1,
              "ReferenceFuelConsumption": 1.1,
              "MaxRPM": 1,
              "VIN": "sample string 9",
              "TrackingObjectType": 0,
              "FuelType": 0,
              "Sensors": [
                {
                  "$id": "13",
                  "SensorId": 1,
                  "SensorName": "sample string 2",
                  "SensorType": 0,
                  "SensorOutputType": 0,
                  "FunctionCode": "sample string 3",
                  "Order": 64,
                  "Mask": "sample string 5",
                  "Visible": true,
                  "Value": {
                    "$id": "14"
                  }
                },
                {
                  "$ref": "13"
                }
              ],
              "HasLocationData": true,
              "Logbook": true
            },
            {
              "$ref": "7"
            }
          ],
          "GroupSenderId": "sample string 4"
        },
        {
          "$ref": "6"
        }
      ],
      "Role": 1,
      "IsActive": true,
      "UserGroup": {
        "$id": "15",
        "UserGroupId": 1,
        "UserGroupName": "sample string 2",
        "Users": [
          {
            "$ref": "3"
          },
          {
            "$ref": "3"
          }
        ]
      },
      "Messages": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ],
      "NotificationType": 1,
      "NotificationSound": 0,
      "TrackingObject": {
        "$ref": "7"
      },
      "Metadata": {
        "$id": "16",
        "LoginSuccessful": "2026-02-02T19:51:09.4106936+01:00",
        "LoginFailed": "2026-02-02T19:51:09.4106936+01:00"
      }
    },
    "IsHighPriority": true,
    "SentDate": "2026-02-02T19:51:09.4106936+01:00"
  },
  {
    "$ref": "1"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.