GET api/v1/devices/{deviceId}/sigfox
Get Sigfox specific details about the device.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deviceId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
SigfoxDeviceDetailsDtoName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Last | integer |
None. |
|
AverageSignal | decimal number |
None. |
|
AverageSnr | decimal number |
None. |
|
AverageRssi | decimal number |
None. |
|
State | decimal number |
None. |
|
Location | LocationDto |
None. |
|
ActivationTime | date |
None. |
|
TokenType | string |
None. |
|
ContractId | string |
None. |
|
TokenEnd | date |
None. |
|
PreventRenewal | boolean |
None. |
|
DateAdded | date |
None. |
|
LastUpdated | date |
None. |
|
Associated |
If this Sigfox device is associated with a Tinamous device. |
boolean |
None. |
AutoAddTinamousDevice |
Allow override of SigfoxBot auto-add Tinamous device to represent this. |
boolean |
None. |
DeviceMongoId |
The tinamous device this is associated with |
globally unique identifier |
None. |
DeviceType |
Sigfox Device Type identifier |
string |
None. |
DeviceTypeName |
Device type name. |
string |
None. |
DownlinkOverusage | boolean |
None. |
|
DownlinkData |
The downlink data to send to the device when it requests a packet. |
string |
None. |
DownlinkDataSetAt |
When the Downlink data was set by the user. |
date |
None. |
DownlinkHistory |
History of downlink data transmissions |
Collection of SigfoxDeviceDownloadDataHistoryDto |
None. |
UplinkHistory | Collection of SigfoxDeviceUplinkHistoryDto |
None. |
|
MessageParserId |
Override of device type to specify an individual message parser. |
globally unique identifier |
None. |
FromApi |
If the Sigfox properties have been loaded from the Sigfox API |
boolean |
None. |
Links | Collection of LinkDto |
None. |
|
Actions | Collection of LinkDto |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "Name": "sample string 1", "Last": 2, "AverageSignal": 3.1, "AverageSnr": 4.1, "AverageRssi": 5.1, "State": 6.1, "Location": { "Name": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "Elevation": 4.1, "WellKnownLocationId": "4a5d3718-4516-43c3-94c8-1ed5454615c8", "LastUpdated": "2024-11-09T00:02:29.2224435+00:00" }, "ActivationTime": "2024-11-09T00:02:29.2224435+00:00", "TokenType": "sample string 8", "ContractId": "sample string 9", "TokenEnd": "2024-11-09T00:02:29.2224435+00:00", "PreventRenewal": true, "DateAdded": "2024-11-09T00:02:29.2224435+00:00", "LastUpdated": "2024-11-09T00:02:29.2224435+00:00", "Associated": true, "AutoAddTinamousDevice": true, "DeviceMongoId": "b136d74c-cf73-446f-914d-520dc5394c9d", "DeviceType": "sample string 17", "DeviceTypeName": "sample string 18", "DownlinkOverusage": true, "DownlinkData": "sample string 20", "DownlinkDataSetAt": "2024-11-09T00:02:29.2224435+00:00", "DownlinkHistory": [ { "SetAt": "2024-11-09T00:02:29.2224435+00:00", "SentAt": "2024-11-09T00:02:29.2224435+00:00", "DataSent": "sample string 3", "Acknowledged": true, "AcknowledgedAt": "2024-11-09T00:02:29.2224435+00:00", "AverageSignalToNoiseRatio": 6.1, "DownlinkOverusage": true, "InfoCode": 8, "InfoMessage": "sample string 9", "Rssi": 10.1, "Snr": 11.1, "Location": { "Name": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "Elevation": 4.1, "WellKnownLocationId": "4a5d3718-4516-43c3-94c8-1ed5454615c8", "LastUpdated": "2024-11-09T00:02:29.2224435+00:00" } }, { "SetAt": "2024-11-09T00:02:29.2224435+00:00", "SentAt": "2024-11-09T00:02:29.2224435+00:00", "DataSent": "sample string 3", "Acknowledged": true, "AcknowledgedAt": "2024-11-09T00:02:29.2224435+00:00", "AverageSignalToNoiseRatio": 6.1, "DownlinkOverusage": true, "InfoCode": 8, "InfoMessage": "sample string 9", "Rssi": 10.1, "Snr": 11.1, "Location": { "Name": "sample string 1", "Latitude": 2.1, "Longitude": 3.1, "Elevation": 4.1, "WellKnownLocationId": "4a5d3718-4516-43c3-94c8-1ed5454615c8", "LastUpdated": "2024-11-09T00:02:29.2224435+00:00" } } ], "UplinkHistory": [ { "Id": "e3b005ae-bef3-4f6c-8436-5ab482382d25", "ReceivedAt": "2024-11-09T00:02:29.2224435+00:00", "SigfoxDeviceId": "sample string 3", "Time": "2024-11-09T00:02:29.2224435+00:00", "Duplicate": true, "Snr": 6.1, "Station": "sample string 7", "AvgerateSignalToNoiseRatio": 8.1, "Lat": 1.1, "Lng": 1.1, "Rssi": 9.1, "SequenceNumber": 10, "Data": "QEA=", "Fields": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Acknowledge": true }, { "Id": "e3b005ae-bef3-4f6c-8436-5ab482382d25", "ReceivedAt": "2024-11-09T00:02:29.2224435+00:00", "SigfoxDeviceId": "sample string 3", "Time": "2024-11-09T00:02:29.2224435+00:00", "Duplicate": true, "Snr": 6.1, "Station": "sample string 7", "AvgerateSignalToNoiseRatio": 8.1, "Lat": 1.1, "Lng": 1.1, "Rssi": 9.1, "SequenceNumber": 10, "Data": "QEA=", "Fields": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Acknowledge": true } ], "MessageParserId": "37f4d9f6-6575-411c-b7e0-b598683fbd25", "FromApi": true, "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ] }
application/xml, text/xml
Sample:
<SigfoxDeviceDetailsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Sigfox.Devices"> <Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Actions> <ActivationTime>2024-11-09T00:02:29.2224435+00:00</ActivationTime> <Associated>true</Associated> <AutoAddTinamousDevice>true</AutoAddTinamousDevice> <AverageRssi>5.1</AverageRssi> <AverageSignal>3.1</AverageSignal> <AverageSnr>4.1</AverageSnr> <ContractId>sample string 9</ContractId> <DateAdded>2024-11-09T00:02:29.2224435+00:00</DateAdded> <DeviceMongoId>b136d74c-cf73-446f-914d-520dc5394c9d</DeviceMongoId> <DeviceType>sample string 17</DeviceType> <DeviceTypeName>sample string 18</DeviceTypeName> <DownlinkData>sample string 20</DownlinkData> <DownlinkDataSetAt>2024-11-09T00:02:29.2224435+00:00</DownlinkDataSetAt> <DownlinkHistory> <SigfoxDeviceDownloadDataHistoryDto> <Acknowledged>true</Acknowledged> <AcknowledgedAt>2024-11-09T00:02:29.2224435+00:00</AcknowledgedAt> <AverageSignalToNoiseRatio>6.1</AverageSignalToNoiseRatio> <DataSent>sample string 3</DataSent> <DownlinkOverusage>true</DownlinkOverusage> <InfoCode>8</InfoCode> <InfoMessage>sample string 9</InfoMessage> <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d4p1:Elevation>4.1</d4p1:Elevation> <d4p1:LastUpdated>2024-11-09T00:02:29.2224435+00:00</d4p1:LastUpdated> <d4p1:Latitude>2.1</d4p1:Latitude> <d4p1:Longitude>3.1</d4p1:Longitude> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:WellKnownLocationId>4a5d3718-4516-43c3-94c8-1ed5454615c8</d4p1:WellKnownLocationId> </Location> <Rssi>10.1</Rssi> <SentAt>2024-11-09T00:02:29.2224435+00:00</SentAt> <SetAt>2024-11-09T00:02:29.2224435+00:00</SetAt> <Snr>11.1</Snr> </SigfoxDeviceDownloadDataHistoryDto> <SigfoxDeviceDownloadDataHistoryDto> <Acknowledged>true</Acknowledged> <AcknowledgedAt>2024-11-09T00:02:29.2224435+00:00</AcknowledgedAt> <AverageSignalToNoiseRatio>6.1</AverageSignalToNoiseRatio> <DataSent>sample string 3</DataSent> <DownlinkOverusage>true</DownlinkOverusage> <InfoCode>8</InfoCode> <InfoMessage>sample string 9</InfoMessage> <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d4p1:Elevation>4.1</d4p1:Elevation> <d4p1:LastUpdated>2024-11-09T00:02:29.2224435+00:00</d4p1:LastUpdated> <d4p1:Latitude>2.1</d4p1:Latitude> <d4p1:Longitude>3.1</d4p1:Longitude> <d4p1:Name>sample string 1</d4p1:Name> <d4p1:WellKnownLocationId>4a5d3718-4516-43c3-94c8-1ed5454615c8</d4p1:WellKnownLocationId> </Location> <Rssi>10.1</Rssi> <SentAt>2024-11-09T00:02:29.2224435+00:00</SentAt> <SetAt>2024-11-09T00:02:29.2224435+00:00</SetAt> <Snr>11.1</Snr> </SigfoxDeviceDownloadDataHistoryDto> </DownlinkHistory> <DownlinkOverusage>true</DownlinkOverusage> <FromApi>true</FromApi> <Last>2</Last> <LastUpdated>2024-11-09T00:02:29.2224435+00:00</LastUpdated> <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Links> <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:Elevation>4.1</d2p1:Elevation> <d2p1:LastUpdated>2024-11-09T00:02:29.2224435+00:00</d2p1:LastUpdated> <d2p1:Latitude>2.1</d2p1:Latitude> <d2p1:Longitude>3.1</d2p1:Longitude> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:WellKnownLocationId>4a5d3718-4516-43c3-94c8-1ed5454615c8</d2p1:WellKnownLocationId> </Location> <MessageParserId>37f4d9f6-6575-411c-b7e0-b598683fbd25</MessageParserId> <Name>sample string 1</Name> <PreventRenewal>true</PreventRenewal> <State>6.1</State> <TokenEnd>2024-11-09T00:02:29.2224435+00:00</TokenEnd> <TokenType>sample string 8</TokenType> <UplinkHistory> <SigfoxDeviceUplinkHistoryDto> <Acknowledge>true</Acknowledge> <AvgerateSignalToNoiseRatio>8.1</AvgerateSignalToNoiseRatio> <Data>QEA=</Data> <Duplicate>true</Duplicate> <Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </Fields> <Id>e3b005ae-bef3-4f6c-8436-5ab482382d25</Id> <Lat>1.1</Lat> <Lng>1.1</Lng> <ReceivedAt>2024-11-09T00:02:29.2224435+00:00</ReceivedAt> <Rssi>9.1</Rssi> <SequenceNumber>10</SequenceNumber> <SigfoxDeviceId>sample string 3</SigfoxDeviceId> <Snr>6.1</Snr> <Station>sample string 7</Station> <Time>2024-11-09T00:02:29.2224435+00:00</Time> </SigfoxDeviceUplinkHistoryDto> <SigfoxDeviceUplinkHistoryDto> <Acknowledge>true</Acknowledge> <AvgerateSignalToNoiseRatio>8.1</AvgerateSignalToNoiseRatio> <Data>QEA=</Data> <Duplicate>true</Duplicate> <Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </Fields> <Id>e3b005ae-bef3-4f6c-8436-5ab482382d25</Id> <Lat>1.1</Lat> <Lng>1.1</Lng> <ReceivedAt>2024-11-09T00:02:29.2224435+00:00</ReceivedAt> <Rssi>9.1</Rssi> <SequenceNumber>10</SequenceNumber> <SigfoxDeviceId>sample string 3</SigfoxDeviceId> <Snr>6.1</Snr> <Station>sample string 7</Station> <Time>2024-11-09T00:02:29.2224435+00:00</Time> </SigfoxDeviceUplinkHistoryDto> </UplinkHistory> </SigfoxDeviceDetailsDto>