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

Associate the Particle device with a Tinamous device.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Particle Bot Id

globally unique identifier

Required

particleDeviceId

The Particle Device Id to associate with the Tinamous device

string

Required

Body Parameters

AssociateDeviceDto
NameDescriptionTypeAdditional information
DeviceId

The Tinamous device Id to associate the particle device with.

globally unique identifier

None.

Request Formats

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

Sample:
{
  "DeviceId": "c8b854d2-8631-4f0a-8a81-d23ad7958e6f"
}

application/xml, text/xml

Sample:
<AssociateDeviceDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Bots.Models">
  <DeviceId>c8b854d2-8631-4f0a-8a81-d23ad7958e6f</DeviceId>
</AssociateDeviceDto>

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>