GET api/v1/devices/{deviceId}/particle

Get Particle.io specific details about the device.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ParticleDeviceDetailsDto
NameDescriptionTypeAdditional information
CheckInterval

How frequently this device should have the variables read.

time interval

None.

DateAdded

When the device was added to the system.

date

None.

Connected

If the device is currently connected.

boolean

None.

Enabled

If collection from this device is enabled.

boolean

None.

LastApp

The last application seen on the device.

string

None.

ParticleDeviceId

The device Id at Particle.io

string

None.

Variables

The variables on the particle device.

Collection of ParticleVariableSettingDto

None.

Functions

List of functions available on the Particle device.

Collection of ParticleFunctionDto

None.

PublishUnknownEventsAsMeasurements

If events with numeric values should be treated as measurements

boolean

None.

PublishUnknownEventsAsStatusPosts

If events with string or no value should be treated as status posts.

boolean

None.

Links

Hypermedia links for the device.

Collection of LinkDto

None.

OnlineNotificationOption

If and how to notify when the device comes online

ParticlsStatusNotifyOptionDto

None.

OfflineNotificationOption

If and how to notify when the device goes offline.

ParticlsStatusNotifyOptionDto

None.

FaultCount

integer

None.

Faulted

boolean

None.

CircuitBreakerResetAt

date

None.

IgnoreRename

boolean

None.

Sim

SimDto

None.

Response Formats

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

Sample:
{
  "CheckInterval": "00:00:00.1234567",
  "DateAdded": "2024-11-03T00:13:59.6000979+00:00",
  "Connected": true,
  "Enabled": true,
  "LastApp": "sample string 5",
  "ParticleDeviceId": "sample string 6",
  "Variables": [
    {
      "CheckInterval": "00:00:00.1234567",
      "Enabled": true,
      "Name": "sample string 3",
      "Type": "sample string 4"
    },
    {
      "CheckInterval": "00:00:00.1234567",
      "Enabled": true,
      "Name": "sample string 3",
      "Type": "sample string 4"
    }
  ],
  "Functions": [
    {
      "Name": "sample string 1",
      "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"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "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"
        }
      ]
    }
  ],
  "PublishUnknownEventsAsMeasurements": true,
  "PublishUnknownEventsAsStatusPosts": 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"
    }
  ],
  "OnlineNotificationOption": {
    "PostStatusMessage": true,
    "Message": "sample string 2"
  },
  "OfflineNotificationOption": {
    "PostStatusMessage": true,
    "Message": "sample string 2"
  },
  "FaultCount": 9,
  "Faulted": true,
  "CircuitBreakerResetAt": "2024-11-03T00:13:59.6000979+00:00",
  "IgnoreRename": true,
  "Sim": {
    "SimId": "sample string 1",
    "BaseCountryCode": "sample string 2",
    "BaseMonthlyRate": 3.1,
    "OverageMonthlyRate": 4.1,
    "FirstActivatedOn": "2024-11-03T00:13:59.6000979+00:00",
    "Imsi": "sample string 6",
    "LastActivatedOn": "2024-11-03T00:13:59.6000979+00:00",
    "LimitMb": 8.1,
    "Status": "sample string 9",
    "Carrier": "sample string 10",
    "Usage": [
      {
        "Date": "2024-11-03T00:13:59.6000979+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      },
      {
        "Date": "2024-11-03T00:13:59.6000979+00:00",
        "UsedMb": 2.1,
        "CumulativeUsageMb": 3.1
      }
    ],
    "LastStatusChangeAction": "sample string 11",
    "LastStatusChangeActionError": "sample string 12",
    "LastUsage": {
      "Date": "2024-11-03T00:13:59.6000979+00:00",
      "UsedMb": 2.1,
      "CumulativeUsageMb": 3.1
    },
    "LastUpdated": "2024-11-03T00:13:59.6000979+00:00",
    "DateAdded": "2024-11-03T00:13:59.6000979+00:00",
    "EstimatedMonthUsage": 15.1
  }
}

application/xml, text/xml

Sample:
<ParticleDeviceDetailsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models">
  <CheckInterval>PT0.1234567S</CheckInterval>
  <CircuitBreakerResetAt>2024-11-03T00:13:59.6000979+00:00</CircuitBreakerResetAt>
  <Connected>true</Connected>
  <DateAdded>2024-11-03T00:13:59.6000979+00:00</DateAdded>
  <Enabled>true</Enabled>
  <FaultCount>9</FaultCount>
  <Faulted>true</Faulted>
  <Functions>
    <ParticleFunctionDto>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <Name>sample string 1</Name>
    </ParticleFunctionDto>
    <ParticleFunctionDto>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
        <d4p1:LinkViewModel>
          <d4p1:Action>sample string 3</d4p1:Action>
          <d4p1:Href>sample string 1</d4p1:Href>
          <d4p1:Rel>sample string 2</d4p1:Rel>
        </d4p1:LinkViewModel>
      </Links>
      <Name>sample string 1</Name>
    </ParticleFunctionDto>
  </Functions>
  <IgnoreRename>true</IgnoreRename>
  <LastApp>sample string 5</LastApp>
  <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>
  <OfflineNotificationOption>
    <Message>sample string 2</Message>
    <PostStatusMessage>true</PostStatusMessage>
  </OfflineNotificationOption>
  <OnlineNotificationOption>
    <Message>sample string 2</Message>
    <PostStatusMessage>true</PostStatusMessage>
  </OnlineNotificationOption>
  <ParticleDeviceId>sample string 6</ParticleDeviceId>
  <PublishUnknownEventsAsMeasurements>true</PublishUnknownEventsAsMeasurements>
  <PublishUnknownEventsAsStatusPosts>true</PublishUnknownEventsAsStatusPosts>
  <Sim xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.SparkBot">
    <d2p1:BaseCountryCode>sample string 2</d2p1:BaseCountryCode>
    <d2p1:BaseMonthlyRate>3.1</d2p1:BaseMonthlyRate>
    <d2p1:Carrier>sample string 10</d2p1:Carrier>
    <d2p1:DateAdded>2024-11-03T00:13:59.6000979+00:00</d2p1:DateAdded>
    <d2p1:EstimatedMonthUsage>15.1</d2p1:EstimatedMonthUsage>
    <d2p1:FirstActivatedOn>2024-11-03T00:13:59.6000979+00:00</d2p1:FirstActivatedOn>
    <d2p1:Imsi>sample string 6</d2p1:Imsi>
    <d2p1:LastActivatedOn>2024-11-03T00:13:59.6000979+00:00</d2p1:LastActivatedOn>
    <d2p1:LastStatusChangeAction>sample string 11</d2p1:LastStatusChangeAction>
    <d2p1:LastStatusChangeActionError>sample string 12</d2p1:LastStatusChangeActionError>
    <d2p1:LastUpdated>2024-11-03T00:13:59.6000979+00:00</d2p1:LastUpdated>
    <d2p1:LastUsage>
      <d2p1:CumulativeUsageMb>3.1</d2p1:CumulativeUsageMb>
      <d2p1:Date>2024-11-03T00:13:59.6000979+00:00</d2p1:Date>
      <d2p1:UsedMb>2.1</d2p1:UsedMb>
    </d2p1:LastUsage>
    <d2p1:LimitMb>8.1</d2p1:LimitMb>
    <d2p1:OverageMonthlyRate>4.1</d2p1:OverageMonthlyRate>
    <d2p1:SimId>sample string 1</d2p1:SimId>
    <d2p1:Status>sample string 9</d2p1:Status>
    <d2p1:Usage>
      <d2p1:SimUsageDto>
        <d2p1:CumulativeUsageMb>3.1</d2p1:CumulativeUsageMb>
        <d2p1:Date>2024-11-03T00:13:59.6000979+00:00</d2p1:Date>
        <d2p1:UsedMb>2.1</d2p1:UsedMb>
      </d2p1:SimUsageDto>
      <d2p1:SimUsageDto>
        <d2p1:CumulativeUsageMb>3.1</d2p1:CumulativeUsageMb>
        <d2p1:Date>2024-11-03T00:13:59.6000979+00:00</d2p1:Date>
        <d2p1:UsedMb>2.1</d2p1:UsedMb>
      </d2p1:SimUsageDto>
    </d2p1:Usage>
  </Sim>
  <Variables>
    <ParticleVariableSettingDto>
      <CheckInterval>PT0.1234567S</CheckInterval>
      <Enabled>true</Enabled>
      <Name>sample string 3</Name>
      <Type>sample string 4</Type>
    </ParticleVariableSettingDto>
    <ParticleVariableSettingDto>
      <CheckInterval>PT0.1234567S</CheckInterval>
      <Enabled>true</Enabled>
      <Name>sample string 3</Name>
      <Type>sample string 4</Type>
    </ParticleVariableSettingDto>
  </Variables>
</ParticleDeviceDetailsDto>