POST api/v1/bots/lifxbots

Register a LifxBot

Request Information

URI Parameters

None.

Body Parameters

RegisterLifxBotDto
NameDescriptionTypeAdditional information
AccessToken

Lifx HTTP API Access Token

string

None.

AddLightsAsDevices

If the Lifx Lights belonging to the LifxBot should be added as Tinamous devices.

boolean

None.

Private

If this lifx bot is private to the user.

boolean

None.

Request Formats

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

Sample:
{
  "AccessToken": "sample string 1",
  "AddLightsAsDevices": true,
  "Private": true
}

application/xml, text/xml

Sample:
<RegisterLifxBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.LifxBot">
  <AccessToken>sample string 1</AccessToken>
  <AddLightsAsDevices>true</AddLightsAsDevices>
  <Private>true</Private>
</RegisterLifxBotDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LifxBotDto
NameDescriptionTypeAdditional information
Lights

Collection of LifxLightDto

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:
{
  "Lights": [
    {
      "LifxId": "sample string 1",
      "Assigned": true,
      "DeviceId": "0fe13be4-b7f5-4da3-b677-6fc1860e47b8",
      "Name": "sample string 4",
      "Power": "sample string 5",
      "Connected": true,
      "BrightnessPercentage": 7,
      "GroupName": "sample string 8",
      "LocationName": "sample string 9",
      "Hue": 10.1,
      "ColorTemperature": 11,
      "Saturation": 12.1,
      "ProductName": "sample string 13",
      "LastSeen": "2017-08-20T15:18:08.7453524+00:00",
      "Links": [],
      "Actions": []
    },
    {
      "LifxId": "sample string 1",
      "Assigned": true,
      "DeviceId": "0fe13be4-b7f5-4da3-b677-6fc1860e47b8",
      "Name": "sample string 4",
      "Power": "sample string 5",
      "Connected": true,
      "BrightnessPercentage": 7,
      "GroupName": "sample string 8",
      "LocationName": "sample string 9",
      "Hue": 10.1,
      "ColorTemperature": 11,
      "Saturation": 12.1,
      "ProductName": "sample string 13",
      "LastSeen": "2017-08-20T15:18:08.7453524+00:00",
      "Links": [],
      "Actions": []
    }
  ],
  "Id": "bed8d25c-ca9b-415c-aa46-b658f30970f9",
  "Name": "sample string 2",
  "UserName": "sample string 3",
  "FullUserName": "sample string 4",
  "BotType": "sample string 5",
  "DisplayName": "sample string 6",
  "DevicesCheckIntervalMinutes": 7,
  "MeasurementCollectionIntervalMinutes": 8,
  "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 9",
  "Enabled": true
}

application/xml, text/xml

Sample:
<LifxBotDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots.LifxBot">
  <Actions xmlns:d2p1="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">
    <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>
  <BotType xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 5</BotType>
  <Description xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 9</Description>
  <DevicesCheckIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">7</DevicesCheckIntervalMinutes>
  <DisplayName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 6</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 4</FullUserName>
  <Id xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">bed8d25c-ca9b-415c-aa46-b658f30970f9</Id>
  <Links xmlns:d2p1="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">
    <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>
  <MeasurementCollectionIntervalMinutes xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">8</MeasurementCollectionIntervalMinutes>
  <Name xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 2</Name>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Bots">sample string 3</UserName>
  <Lights>
    <LifxLightDto>
      <Actions xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <Assigned>true</Assigned>
      <BrightnessPercentage>7</BrightnessPercentage>
      <ColorTemperature>11</ColorTemperature>
      <Connected>true</Connected>
      <DeviceId>0fe13be4-b7f5-4da3-b677-6fc1860e47b8</DeviceId>
      <GroupName>sample string 8</GroupName>
      <Hue>10.1</Hue>
      <LastSeen>2017-08-20T15:18:08.7453524+00:00</LastSeen>
      <LifxId>sample string 1</LifxId>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <LocationName>sample string 9</LocationName>
      <Name>sample string 4</Name>
      <Power>sample string 5</Power>
      <ProductName>sample string 13</ProductName>
      <Saturation>12.1</Saturation>
    </LifxLightDto>
    <LifxLightDto>
      <Actions xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <Assigned>true</Assigned>
      <BrightnessPercentage>7</BrightnessPercentage>
      <ColorTemperature>11</ColorTemperature>
      <Connected>true</Connected>
      <DeviceId>0fe13be4-b7f5-4da3-b677-6fc1860e47b8</DeviceId>
      <GroupName>sample string 8</GroupName>
      <Hue>10.1</Hue>
      <LastSeen>2017-08-20T15:18:08.7453524+00:00</LastSeen>
      <LifxId>sample string 1</LifxId>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared" />
      <LocationName>sample string 9</LocationName>
      <Name>sample string 4</Name>
      <Power>sample string 5</Power>
      <ProductName>sample string 13</ProductName>
      <Saturation>12.1</Saturation>
    </LifxLightDto>
  </Lights>
</LifxBotDto>