POST api/packcenter/getmessages

Get tracking messages for PC placements with possiblity to filter by datetime and defining limit and offset of answer

Request Information

URI Parameters

None.

Body Parameters

Get Messages Request parameters

Name	Description	Type	Additional information
PlacementIds	Entity Code	Collection of globally unique identifier	None.
From	Business Unit Id	date	None.
To	Device Assignment Id	date	None.
Limit	Limit response message count	integer	None.
Offset	Offset for response answer	integer	None.
Ids	List id of Tracking Messages	Collection of globally unique identifier	None.
Last	Last row only	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "PlacementIds": [
    "ba16310d-ef26-4915-8654-7956c01c930b",
    "b3884ada-d915-437e-861e-18d1b189d94c"
  ],
  "From": "2024-09-19T10:17:43.8675981+02:00",
  "To": "2024-09-19T10:17:43.8675981+02:00",
  "Limit": 1,
  "Offset": 2,
  "Ids": [
    "5f6d1781-144e-4827-9e97-22c29185980a",
    "60ac5587-5167-40a5-bd89-4aa4d922c6c1"
  ],
  "Last": true
}

application/xml, text/xml

Sample:

<GetMessagesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Deufol.CPCNL.API.Classes">
  <From>2024-09-19T10:17:43.8675981+02:00</From>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>5f6d1781-144e-4827-9e97-22c29185980a</d2p1:guid>
    <d2p1:guid>60ac5587-5167-40a5-bd89-4aa4d922c6c1</d2p1:guid>
  </Ids>
  <Last>true</Last>
  <Limit>1</Limit>
  <Offset>2</Offset>
  <PlacementIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>ba16310d-ef26-4915-8654-7956c01c930b</d2p1:guid>
    <d2p1:guid>b3884ada-d915-437e-861e-18d1b189d94c</d2p1:guid>
  </PlacementIds>
  <To>2024-09-19T10:17:43.8675981+02:00</To>
</GetMessagesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TrackingMessageApiModel

Name	Type	Additional information
RecordCount	integer	None.
Limit	integer	None.
Offset	integer	None.
Data	Collection of TrackingMessageApiRecord	None.

Response Formats

application/json, text/json

Sample:

{
  "RecordCount": 1,
  "Limit": 2,
  "Offset": 3,
  "Data": [
    {
      "Id": "5d59e370-535c-4a1c-a4ab-a7ddcf6fba36",
      "DevicePlacementId": "5e883e8e-84cc-489c-b831-641adea9d41b",
      "DevicePlacementName": "sample string 3",
      "DeviceCode": "sample string 4",
      "RecordDateTime": "2024-09-19T10:17:43.8675981+02:00",
      "Temperature": 6,
      "Humidity": 7,
      "Pressure": 8,
      "AccelerationX": 9.1,
      "AccelerationY": 10.1,
      "AccelerationZ": 11.1,
      "Latitude": 12.1,
      "Longitude": 13.1,
      "BateryStatus": 14.1,
      "LightSensor": 15.1
    },
    {
      "Id": "5d59e370-535c-4a1c-a4ab-a7ddcf6fba36",
      "DevicePlacementId": "5e883e8e-84cc-489c-b831-641adea9d41b",
      "DevicePlacementName": "sample string 3",
      "DeviceCode": "sample string 4",
      "RecordDateTime": "2024-09-19T10:17:43.8675981+02:00",
      "Temperature": 6,
      "Humidity": 7,
      "Pressure": 8,
      "AccelerationX": 9.1,
      "AccelerationY": 10.1,
      "AccelerationZ": 11.1,
      "Latitude": 12.1,
      "Longitude": 13.1,
      "BateryStatus": 14.1,
      "LightSensor": 15.1
    }
  ]
}

application/xml, text/xml

Sample:

<TrackingMessageApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Deufol.CPCNL.BLL.Models.ApiModels">
  <Data>
    <TrackingMessageApiRecord>
      <AccelerationX>9.1</AccelerationX>
      <AccelerationY>10.1</AccelerationY>
      <AccelerationZ>11.1</AccelerationZ>
      <BateryStatus>14.1</BateryStatus>
      <DeviceCode>sample string 4</DeviceCode>
      <DevicePlacementId>5e883e8e-84cc-489c-b831-641adea9d41b</DevicePlacementId>
      <DevicePlacementName>sample string 3</DevicePlacementName>
      <Humidity>7</Humidity>
      <Id>5d59e370-535c-4a1c-a4ab-a7ddcf6fba36</Id>
      <Latitude>12.1</Latitude>
      <LightSensor>15.1</LightSensor>
      <Longitude>13.1</Longitude>
      <Pressure>8</Pressure>
      <RecordDateTime>2024-09-19T10:17:43.8675981+02:00</RecordDateTime>
      <Temperature>6</Temperature>
    </TrackingMessageApiRecord>
    <TrackingMessageApiRecord>
      <AccelerationX>9.1</AccelerationX>
      <AccelerationY>10.1</AccelerationY>
      <AccelerationZ>11.1</AccelerationZ>
      <BateryStatus>14.1</BateryStatus>
      <DeviceCode>sample string 4</DeviceCode>
      <DevicePlacementId>5e883e8e-84cc-489c-b831-641adea9d41b</DevicePlacementId>
      <DevicePlacementName>sample string 3</DevicePlacementName>
      <Humidity>7</Humidity>
      <Id>5d59e370-535c-4a1c-a4ab-a7ddcf6fba36</Id>
      <Latitude>12.1</Latitude>
      <LightSensor>15.1</LightSensor>
      <Longitude>13.1</Longitude>
      <Pressure>8</Pressure>
      <RecordDateTime>2024-09-19T10:17:43.8675981+02:00</RecordDateTime>
      <Temperature>6</Temperature>
    </TrackingMessageApiRecord>
  </Data>
  <Limit>2</Limit>
  <Offset>3</Offset>
  <RecordCount>1</RecordCount>
</TrackingMessageApiModel>