GET api/v1/bots/sparkbots

Get all ParticleBots for the current account. (should this also be filtered on the user?)

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ParticleBotDto
NameDescriptionTypeAdditional information
AutoAddDevice

boolean

None.

TokenExpiresOn

date

None.

HasTokenExpired

boolean

None.

ParticleAccount

string

None.

Devices

Collection of ParticleDeviceSummaryDto

None.

DeviceTags

Collection of string

None.

AllowStatusMessageCommands

Allow status messages to be used to invoke Alexa SmartHome functions

boolean

None.

LimitStatusMessageCommandsToUser

Only allow status message commands from this member/device (Null allows any member/device).

globally unique identifier

None.

AuthenticationFailCount

How many authentication failures have been seen

integer

None.

HasError

If the bot has errors

boolean

None.

StreamingCollectionEnabled

If the bot should use a stream connection to collect data from the device.

boolean

None.

VariableCollectionEnabled

boolean

None.

DevicesCheckInterval

How often the users account should check for new devices

time interval

None.

DefaultMeasurementCollectionInterval

Default for how often the device should be checked for measurement collection.

time interval

None.

LastSimUpdatedAt

When the sims were last updated

date

None.

LastCheckedDevicesAt

When the last devices check occured

date

None.

Id

User Id

globally unique identifier

None.

Name

The users name

string

None.

UserName

UserName (used to login with)

string

None.

FullUserName

User Id and Account name

string

None.

BotType

The type of bot.

string

None.

DisplayName

Users first and last name

string

None.

DevicesCheckIntervalMinutes

How often the spark account should be checked for new devices.

integer

None.

MeasurementCollectionIntervalMinutes

How often measurements should be collected from the devices (applies to new devices only).

integer

None.

Links

Collection of links appropriate for the user

Collection of LinkDto

None.

Actions

Collection of LinkDto

None.

Description

string

None.

Enabled

boolean

None.

Response Formats

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

Sample:
[
  {
    "AutoAddDevice": true,
    "TokenExpiresOn": "2019-12-15T08:30:43.3563105+00:00",
    "HasTokenExpired": true,
    "ParticleAccount": "sample string 4",
    "Devices": [
      {
        "Id": "30aad423-f6f0-4c39-a071-965741fa73c8",
        "UserName": "sample string 2",
        "ParticleDeviceId": "sample string 3",
        "ParticleDeviceType": 4,
        "ParticleDeviceTypeName": "sample string 5",
        "Name": "sample string 6",
        "Associated": true,
        "Links": [],
        "Actions": []
      },
      {
        "Id": "30aad423-f6f0-4c39-a071-965741fa73c8",
        "UserName": "sample string 2",
        "ParticleDeviceId": "sample string 3",
        "ParticleDeviceType": 4,
        "ParticleDeviceTypeName": "sample string 5",
        "Name": "sample string 6",
        "Associated": true,
        "Links": [],
        "Actions": []
      }
    ],
    "DeviceTags": [
      "sample string 1",
      "sample string 2"
    ],
    "AllowStatusMessageCommands": true,
    "LimitStatusMessageCommandsToUser": "2271c707-5124-442b-a4dc-586ce074f07f",
    "CollectorId": 6,
    "AuthenticationFailCount": 7,
    "HasError": true,
    "StreamingCollectionEnabled": true,
    "VariableCollectionEnabled": true,
    "DevicesCheckInterval": "00:00:00.1234567",
    "DefaultMeasurementCollectionInterval": "00:00:00.1234567",
    "LastSimUpdatedAt": "2019-12-15T08:30:43.3563105+00:00",
    "LastCheckedDevicesAt": "2019-12-15T08:30:43.3563105+00:00",
    "Id": "70d776e1-950d-4888-a15e-4ff265be2a4e",
    "Name": "sample string 15",
    "UserName": "sample string 16",
    "FullUserName": "sample string 17",
    "BotType": "sample string 18",
    "DisplayName": "sample string 19",
    "DevicesCheckIntervalMinutes": 20,
    "MeasurementCollectionIntervalMinutes": 21,
    "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"
      }
    ],
    "Description": "sample string 22",
    "Enabled": true
  },
  {
    "AutoAddDevice": true,
    "TokenExpiresOn": "2019-12-15T08:30:43.3563105+00:00",
    "HasTokenExpired": true,
    "ParticleAccount": "sample string 4",
    "Devices": [
      {
        "Id": "30aad423-f6f0-4c39-a071-965741fa73c8",
        "UserName": "sample string 2",
        "ParticleDeviceId": "sample string 3",
        "ParticleDeviceType": 4,
        "ParticleDeviceTypeName": "sample string 5",
        "Name": "sample string 6",
        "Associated": true,
        "Links": [],
        "Actions": []
      },
      {
        "Id": "30aad423-f6f0-4c39-a071-965741fa73c8",
        "UserName": "sample string 2",
        "ParticleDeviceId": "sample string 3",
        "ParticleDeviceType": 4,
        "ParticleDeviceTypeName": "sample string 5",
        "Name": "sample string 6",
        "Associated": true,
        "Links": [],
        "Actions": []
      }
    ],
    "DeviceTags": [
      "sample string 1",
      "sample string 2"
    ],
    "AllowStatusMessageCommands": true,
    "LimitStatusMessageCommandsToUser": "2271c707-5124-442b-a4dc-586ce074f07f",
    "CollectorId": 6,
    "AuthenticationFailCount": 7,
    "HasError": true,
    "StreamingCollectionEnabled": true,
    "VariableCollectionEnabled": true,
    "DevicesCheckInterval": "00:00:00.1234567",
    "DefaultMeasurementCollectionInterval": "00:00:00.1234567",
    "LastSimUpdatedAt": "2019-12-15T08:30:43.3563105+00:00",
    "LastCheckedDevicesAt": "2019-12-15T08:30:43.3563105+00:00",
    "Id": "70d776e1-950d-4888-a15e-4ff265be2a4e",
    "Name": "sample string 15",
    "UserName": "sample string 16",
    "FullUserName": "sample string 17",
    "BotType": "sample string 18",
    "DisplayName": "sample string 19",
    "DevicesCheckIntervalMinutes": 20,
    "MeasurementCollectionIntervalMinutes": 21,
    "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"
      }
    ],
    "Description": "sample string 22",
    "Enabled": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfParticleBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.SparkBot">
  <ParticleBotDto>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Actions>
    <BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 18</BotType>
    <Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 22</Description>
    <DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">20</DevicesCheckIntervalMinutes>
    <DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 19</DisplayName>
    <Enabled xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Enabled>
    <FullUserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 17</FullUserName>
    <Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">70d776e1-950d-4888-a15e-4ff265be2a4e</Id>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Links>
    <MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">21</MeasurementCollectionIntervalMinutes>
    <Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 15</Name>
    <UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 16</UserName>
    <AllowStatusMessageCommands>true</AllowStatusMessageCommands>
    <AuthenticationFailCount>7</AuthenticationFailCount>
    <AutoAddDevice>true</AutoAddDevice>
    <CollectorId>6</CollectorId>
    <DefaultMeasurementCollectionInterval>PT0.1234567S</DefaultMeasurementCollectionInterval>
    <DeviceTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </DeviceTags>
    <Devices xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Bots.Models">
      <d3p1:ParticleDeviceSummaryDto>
        <d3p1:Actions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Associated>true</d3p1:Associated>
        <d3p1:Id>30aad423-f6f0-4c39-a071-965741fa73c8</d3p1:Id>
        <d3p1:Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:ParticleDeviceId>sample string 3</d3p1:ParticleDeviceId>
        <d3p1:ParticleDeviceType>4</d3p1:ParticleDeviceType>
        <d3p1:ParticleDeviceTypeName>sample string 5</d3p1:ParticleDeviceTypeName>
        <d3p1:UserName>sample string 2</d3p1:UserName>
      </d3p1:ParticleDeviceSummaryDto>
      <d3p1:ParticleDeviceSummaryDto>
        <d3p1:Actions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Associated>true</d3p1:Associated>
        <d3p1:Id>30aad423-f6f0-4c39-a071-965741fa73c8</d3p1:Id>
        <d3p1:Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:ParticleDeviceId>sample string 3</d3p1:ParticleDeviceId>
        <d3p1:ParticleDeviceType>4</d3p1:ParticleDeviceType>
        <d3p1:ParticleDeviceTypeName>sample string 5</d3p1:ParticleDeviceTypeName>
        <d3p1:UserName>sample string 2</d3p1:UserName>
      </d3p1:ParticleDeviceSummaryDto>
    </Devices>
    <DevicesCheckInterval>PT0.1234567S</DevicesCheckInterval>
    <HasError>true</HasError>
    <HasTokenExpired>true</HasTokenExpired>
    <LastCheckedDevicesAt>2019-12-15T08:30:43.3563105+00:00</LastCheckedDevicesAt>
    <LastSimUpdatedAt>2019-12-15T08:30:43.3563105+00:00</LastSimUpdatedAt>
    <LimitStatusMessageCommandsToUser>2271c707-5124-442b-a4dc-586ce074f07f</LimitStatusMessageCommandsToUser>
    <ParticleAccount>sample string 4</ParticleAccount>
    <StreamingCollectionEnabled>true</StreamingCollectionEnabled>
    <TokenExpiresOn>2019-12-15T08:30:43.3563105+00:00</TokenExpiresOn>
    <VariableCollectionEnabled>true</VariableCollectionEnabled>
  </ParticleBotDto>
  <ParticleBotDto>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Actions>
    <BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 18</BotType>
    <Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 22</Description>
    <DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">20</DevicesCheckIntervalMinutes>
    <DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 19</DisplayName>
    <Enabled xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">true</Enabled>
    <FullUserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 17</FullUserName>
    <Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">70d776e1-950d-4888-a15e-4ff265be2a4e</Id>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Links>
    <MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">21</MeasurementCollectionIntervalMinutes>
    <Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 15</Name>
    <UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 16</UserName>
    <AllowStatusMessageCommands>true</AllowStatusMessageCommands>
    <AuthenticationFailCount>7</AuthenticationFailCount>
    <AutoAddDevice>true</AutoAddDevice>
    <CollectorId>6</CollectorId>
    <DefaultMeasurementCollectionInterval>PT0.1234567S</DefaultMeasurementCollectionInterval>
    <DeviceTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </DeviceTags>
    <Devices xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Bots.Models">
      <d3p1:ParticleDeviceSummaryDto>
        <d3p1:Actions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Associated>true</d3p1:Associated>
        <d3p1:Id>30aad423-f6f0-4c39-a071-965741fa73c8</d3p1:Id>
        <d3p1:Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:ParticleDeviceId>sample string 3</d3p1:ParticleDeviceId>
        <d3p1:ParticleDeviceType>4</d3p1:ParticleDeviceType>
        <d3p1:ParticleDeviceTypeName>sample string 5</d3p1:ParticleDeviceTypeName>
        <d3p1:UserName>sample string 2</d3p1:UserName>
      </d3p1:ParticleDeviceSummaryDto>
      <d3p1:ParticleDeviceSummaryDto>
        <d3p1:Actions xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Associated>true</d3p1:Associated>
        <d3p1:Id>30aad423-f6f0-4c39-a071-965741fa73c8</d3p1:Id>
        <d3p1:Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
        <d3p1:Name>sample string 6</d3p1:Name>
        <d3p1:ParticleDeviceId>sample string 3</d3p1:ParticleDeviceId>
        <d3p1:ParticleDeviceType>4</d3p1:ParticleDeviceType>
        <d3p1:ParticleDeviceTypeName>sample string 5</d3p1:ParticleDeviceTypeName>
        <d3p1:UserName>sample string 2</d3p1:UserName>
      </d3p1:ParticleDeviceSummaryDto>
    </Devices>
    <DevicesCheckInterval>PT0.1234567S</DevicesCheckInterval>
    <HasError>true</HasError>
    <HasTokenExpired>true</HasTokenExpired>
    <LastCheckedDevicesAt>2019-12-15T08:30:43.3563105+00:00</LastCheckedDevicesAt>
    <LastSimUpdatedAt>2019-12-15T08:30:43.3563105+00:00</LastSimUpdatedAt>
    <LimitStatusMessageCommandsToUser>2271c707-5124-442b-a4dc-586ce074f07f</LimitStatusMessageCommandsToUser>
    <ParticleAccount>sample string 4</ParticleAccount>
    <StreamingCollectionEnabled>true</StreamingCollectionEnabled>
    <TokenExpiresOn>2019-12-15T08:30:43.3563105+00:00</TokenExpiresOn>
    <VariableCollectionEnabled>true</VariableCollectionEnabled>
  </ParticleBotDto>
</ArrayOfParticleBotDto>