POST api/v1/bots/sparkbots/{id}/Create/{particleDeviceId}

Create a Tinamous device for the Particle device (where the Particle bot has been set to not auto-add or the device has been disassociated).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ParticleBot Id

globally unique identifier

Required

particleDeviceId

Particle.io device Id.

string

Required

Body Parameters

CreateDeviceDto
NameDescriptionTypeAdditional information
UserName

string

Required

DisplayName

string

None.

Request Formats

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

Sample:
{
  "UserName": "sample string 1",
  "DisplayName": "sample string 2"
}

application/xml, text/xml

Sample:
<CreateDeviceDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models">
  <DisplayName>sample string 2</DisplayName>
  <UserName>sample string 1</UserName>
</CreateDeviceDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ParticleVariableValueDto
NameDescriptionTypeAdditional information
Name

string

None.

Value

string

None.

Type

string

None.

TimeTakenMilliSeconds

decimal number

None.

Response Formats

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

Sample:
{
  "Name": "sample string 1",
  "Value": "sample string 2",
  "Type": "sample string 3",
  "TimeTakenMilliSeconds": 4.1
}

application/xml, text/xml

Sample:
<ParticleVariableValueDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Particle.Models">
  <Name>sample string 1</Name>
  <TimeTakenMilliSeconds>4.1</TimeTakenMilliSeconds>
  <Type>sample string 3</Type>
  <Value>sample string 2</Value>
</ParticleVariableValueDto>