POST api/v1/sigfox/data/uplink

POST Sigfox uplink data. Supports both UPLINK and BIDIR.

Request Information

URI Parameters

None.

Body Parameters

SigfoxDataUplinkDto
NameDescriptionTypeAdditional information
Device

string

None.

Time

integer

None.

Duplicate

boolean

None.

Snr

decimal number

None.

Station

string

None.

AvgSnr

decimal number

None.

Lat

decimal number

None.

Lng

decimal number

None.

Rssi

decimal number

None.

SeqNumber

integer

None.

Data

The raw data from the Sigfox device.

Collection of byte

None.

Fields

Json custom fields (e.g. {"Temperature":"customData#temperature"}

Dictionary of string [key] and string [value]

None.

Ack

boolean

None.

LongPolling

boolean

None.

Request Formats

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

Sample:
{
  "Device": "sample string 1",
  "Time": 1,
  "Duplicate": true,
  "Snr": 3.1,
  "Station": "sample string 4",
  "AvgSnr": 5.1,
  "Lat": 1.1,
  "Lng": 1.1,
  "Rssi": 6.1,
  "SeqNumber": 7,
  "Data": "QEA=",
  "Fields": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Ack": true,
  "LongPolling": true
}

application/xml, text/xml

Sample:
<SigfoxDataUplinkDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Sigfox">
  <Ack>true</Ack>
  <AvgSnr>5.1</AvgSnr>
  <Data>QEA=</Data>
  <Device>sample string 1</Device>
  <Duplicate>true</Duplicate>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Fields>
  <Lat>1.1</Lat>
  <Lng>1.1</Lng>
  <LongPolling>true</LongPolling>
  <Rssi>6.1</Rssi>
  <SeqNumber>7</SeqNumber>
  <Snr>3.1</Snr>
  <Station>sample string 4</Station>
  <Time>1</Time>
</SigfoxDataUplinkDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 OK if ok. Empty body for Ack = false or not supplied. 204 No Content if Ack set and no content 200 OK with content if Ack set and downlink data available. Bad request for missing device identifier. Internal server error for unexpected errors.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.