POST api/v1/thethingsnetwork/v3/uplink

Upload data from The Things Network HTTP Integration V3.

Request Information

URI Parameters

None.

Body Parameters

UplinkMessageV3Dto
NameDescriptionTypeAdditional information
end_device_ids

EndDeviceIds

None.

correlation_ids

Correlation identifiers of the message

Collection of string

None.

received_at

ISO 8601 UTC timestamp at which the message has been received by the Application Server

date

None.

uplink_message

UplinkMessage

None.

simulated

Signals if the message is coming from the Network Server or is simulated.

boolean

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": "2021-10-17T04:19:30.9633256+00:00",
  "uplink_message": {
    "session_key_id": "sample string 1",
    "f_port": 2,
    "f_cnt": 3,
    "frm_payload": "sample string 4",
    "decoded_payload": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "decoded_payload_warnings": [
      {},
      {}
    ],
    "rx_metadata": [
      {
        "gateway_ids": {
          "gateway_id": "sample string 1",
          "eui": "sample string 2"
        },
        "packet_broker": {
          "message_id": "sample string 1",
          "forwarder_net_id": "sample string 2",
          "forwarder_tenant_id": "sample string 3",
          "forwarder_cluster_id": "sample string 4",
          "forwarder_gateway_eui": "sample string 5",
          "forwarder_gateway_id": "sample string 6",
          "home_network_net_id": "sample string 7",
          "home_network_tenant_id": "sample string 8",
          "home_network_cluster_id": "sample string 9"
        },
        "time": "2021-10-17T04:19:30.9633256+00:00",
        "timestamp": 2,
        "rssi": 3,
        "signal_rssi": 4,
        "channel_rssi": 5,
        "channel_index": 6,
        "snr": 7.1,
        "frequency_offset": "sample string 8",
        "uplink_token": "sample string 9",
        "location": {
          "latitude": 1.1,
          "longitude": 1.1,
          "altitude": 1.1,
          "source": "sample string 1"
        }
      },
      {
        "gateway_ids": {
          "gateway_id": "sample string 1",
          "eui": "sample string 2"
        },
        "packet_broker": {
          "message_id": "sample string 1",
          "forwarder_net_id": "sample string 2",
          "forwarder_tenant_id": "sample string 3",
          "forwarder_cluster_id": "sample string 4",
          "forwarder_gateway_eui": "sample string 5",
          "forwarder_gateway_id": "sample string 6",
          "home_network_net_id": "sample string 7",
          "home_network_tenant_id": "sample string 8",
          "home_network_cluster_id": "sample string 9"
        },
        "time": "2021-10-17T04:19:30.9633256+00:00",
        "timestamp": 2,
        "rssi": 3,
        "signal_rssi": 4,
        "channel_rssi": 5,
        "channel_index": 6,
        "snr": 7.1,
        "frequency_offset": "sample string 8",
        "uplink_token": "sample string 9",
        "location": {
          "latitude": 1.1,
          "longitude": 1.1,
          "altitude": 1.1,
          "source": "sample string 1"
        }
      }
    ],
    "settings": {
      "data_rate": {
        "lora": {
          "bandwidth": 1,
          "spreading_factor": 2
        }
      },
      "data_rate_index": 1,
      "coding_rate": "sample string 2",
      "frequency": "sample string 3"
    },
    "received_at": "2021-10-17T04:19:30.9633256+00:00",
    "consumed_airtime": "sample string 6",
    "network_ids": {
      "net_id": "sample string 1",
      "tenant_id": "sample string 2",
      "cluster_id": "sample string 3"
    },
    "locations": {
      "user": {
        "latitude": 1.1,
        "longitude": 1.1,
        "altitude": 1.1,
        "source": "sample string 1"
      }
    }
  },
  "simulated": true
}

application/xml, text/xml

Sample:
<UplinkMessageV3Dto 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>
  <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>2021-10-17T04:19:30.9633256+00:00</ReceivedAt>
  <Simulated>true</Simulated>
  <UplinkMessage>
    <ConsumedAirtime>sample string 6</ConsumedAirtime>
    <DecodedPayload xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </DecodedPayload>
    <DecodedPayloadWarnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </DecodedPayloadWarnings>
    <FrameCounter>3</FrameCounter>
    <FramePayload>sample string 4</FramePayload>
    <FramePort>2</FramePort>
    <Locations>
      <User>
        <Altitude>1.1</Altitude>
        <Latitude>1.1</Latitude>
        <Longitude>1.1</Longitude>
        <Source>sample string 1</Source>
      </User>
    </Locations>
    <NetworkIds>
      <ClusterId>sample string 3</ClusterId>
      <NetId>sample string 1</NetId>
      <TenantId>sample string 2</TenantId>
    </NetworkIds>
    <ReceivedAt>2021-10-17T04:19:30.9633256+00:00</ReceivedAt>
    <RxMetadata>
      <RxMetadata>
        <ChannelIndex>6</ChannelIndex>
        <ChannelRssi>5</ChannelRssi>
        <FrequencyOffset>sample string 8</FrequencyOffset>
        <GatewayIds>
          <Eui>sample string 2</Eui>
          <GatewayId>sample string 1</GatewayId>
        </GatewayIds>
        <Location>
          <Altitude>1.1</Altitude>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Source>sample string 1</Source>
        </Location>
        <PacketBroker>
          <ForwarderClusterId>sample string 4</ForwarderClusterId>
          <ForwarderGatewayEui>sample string 5</ForwarderGatewayEui>
          <ForwarderGatewayId>sample string 6</ForwarderGatewayId>
          <ForwarderNetId>sample string 2</ForwarderNetId>
          <ForwarderTenantId>sample string 3</ForwarderTenantId>
          <HomeNetworkClusterId>sample string 9</HomeNetworkClusterId>
          <HomeNetworkNetId>sample string 7</HomeNetworkNetId>
          <HomeNetworkTenantId>sample string 8</HomeNetworkTenantId>
          <MessageId>sample string 1</MessageId>
        </PacketBroker>
        <Rssi>3</Rssi>
        <SignalRssi>4</SignalRssi>
        <Snr>7.1</Snr>
        <Time>2021-10-17T04:19:30.9633256+00:00</Time>
        <Timestamp>2</Timestamp>
        <UplinkToken>sample string 9</UplinkToken>
      </RxMetadata>
      <RxMetadata>
        <ChannelIndex>6</ChannelIndex>
        <ChannelRssi>5</ChannelRssi>
        <FrequencyOffset>sample string 8</FrequencyOffset>
        <GatewayIds>
          <Eui>sample string 2</Eui>
          <GatewayId>sample string 1</GatewayId>
        </GatewayIds>
        <Location>
          <Altitude>1.1</Altitude>
          <Latitude>1.1</Latitude>
          <Longitude>1.1</Longitude>
          <Source>sample string 1</Source>
        </Location>
        <PacketBroker>
          <ForwarderClusterId>sample string 4</ForwarderClusterId>
          <ForwarderGatewayEui>sample string 5</ForwarderGatewayEui>
          <ForwarderGatewayId>sample string 6</ForwarderGatewayId>
          <ForwarderNetId>sample string 2</ForwarderNetId>
          <ForwarderTenantId>sample string 3</ForwarderTenantId>
          <HomeNetworkClusterId>sample string 9</HomeNetworkClusterId>
          <HomeNetworkNetId>sample string 7</HomeNetworkNetId>
          <HomeNetworkTenantId>sample string 8</HomeNetworkTenantId>
          <MessageId>sample string 1</MessageId>
        </PacketBroker>
        <Rssi>3</Rssi>
        <SignalRssi>4</SignalRssi>
        <Snr>7.1</Snr>
        <Time>2021-10-17T04:19:30.9633256+00:00</Time>
        <Timestamp>2</Timestamp>
        <UplinkToken>sample string 9</UplinkToken>
      </RxMetadata>
    </RxMetadata>
    <SessionKeyId>sample string 1</SessionKeyId>
    <Settings>
      <CodingRate>sample string 2</CodingRate>
      <DataRate>
        <Lora>
          <Bandwidth>1</Bandwidth>
          <SpreadingFactor>2</SpreadingFactor>
        </Lora>
      </DataRate>
      <DataRateIndex>1</DataRateIndex>
      <Frequency>sample string 3</Frequency>
    </Settings>
  </UplinkMessage>
</UplinkMessageV3Dto>

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.