POST api/v1/thethingsnetwork/v3/downlinkevent

Downlink event (ack, nack, queued and sent)

Request Information

URI Parameters

None.

Body Parameters

DownlinkEventDto
NameDescriptionTypeAdditional information
end_device_ids

EndDeviceIds

None.

correlation_ids

Collection of string

None.

received_at

string

None.

downlink_queued

Name of the event (ack, nack, queued or sent)

DownlinkEvent

None.

downlink_ack

DownlinkEvent

None.

downlink_nack

DownlinkEvent

None.

downlink_sent

DownlinkEvent

None.

Request Formats

application/json, text/json, application/senml+json

Sample:
{
  "end_device_ids": {
    "device_id": "sample string 1",
    "application_ids": {
      "application_id": "sample string 1"
    },
    "dev_eui": "sample string 2",
    "join_eui": "sample string 3",
    "dev_addr": "sample string 4"
  },
  "correlation_ids": [
    "sample string 1",
    "sample string 2"
  ],
  "received_at": "sample string 1",
  "downlink_queued": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "confirmed": true,
    "priority": "sample string 6",
    "correlation_ids": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "downlink_ack": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "confirmed": true,
    "priority": "sample string 6",
    "correlation_ids": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "downlink_nack": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "confirmed": true,
    "priority": "sample string 6",
    "correlation_ids": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "downlink_sent ": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "confirmed": true,
    "priority": "sample string 6",
    "correlation_ids": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<DownlinkEventDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.TheThingsNetwork.V3">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <DownlinkAck>
    <Confirmed>true</Confirmed>
    <CorrelationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CorrelationIds>
    <FCnt>3</FCnt>
    <FPort>2</FPort>
    <FrmPayload>sample string 4</FrmPayload>
    <Priority>sample string 6</Priority>
    <SessionKeyId>sample string 1</SessionKeyId>
  </DownlinkAck>
  <DownlinkEvent>
    <Confirmed>true</Confirmed>
    <CorrelationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CorrelationIds>
    <FCnt>3</FCnt>
    <FPort>2</FPort>
    <FrmPayload>sample string 4</FrmPayload>
    <Priority>sample string 6</Priority>
    <SessionKeyId>sample string 1</SessionKeyId>
  </DownlinkEvent>
  <DownlinkNack>
    <Confirmed>true</Confirmed>
    <CorrelationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CorrelationIds>
    <FCnt>3</FCnt>
    <FPort>2</FPort>
    <FrmPayload>sample string 4</FrmPayload>
    <Priority>sample string 6</Priority>
    <SessionKeyId>sample string 1</SessionKeyId>
  </DownlinkNack>
  <DownlinkSent>
    <Confirmed>true</Confirmed>
    <CorrelationIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </CorrelationIds>
    <FCnt>3</FCnt>
    <FPort>2</FPort>
    <FrmPayload>sample string 4</FrmPayload>
    <Priority>sample string 6</Priority>
    <SessionKeyId>sample string 1</SessionKeyId>
  </DownlinkSent>
  <EndDeviceIds>
    <ApplicationIds>
      <ApplicationId>sample string 1</ApplicationId>
    </ApplicationIds>
    <DevAddr>sample string 4</DevAddr>
    <DevEui>sample string 2</DevEui>
    <DeviceId>sample string 1</DeviceId>
    <JoinEui>sample string 3</JoinEui>
  </EndDeviceIds>
  <ReceivedAt>sample string 1</ReceivedAt>
</DownlinkEventDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, application/senml+json

Sample:

Sample not available.