Viviot.Api

PutThingStates

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin, Receptionist

The following routes are available for this service:
PUT	/thing/states	Updates state(s) of individual things (as a business user).

**PutThingStates** Parameters:
Name	Parameter	Data Type	Required	Description
ThingId	body	string	Yes	Thing Id (GUID).
States	body	List<StateValue>	Yes	List of state names and their values.
Properties	body	Dictionary<string, string>	No	Dictionary with key value pairs of all thing properties.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**StateValue** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**ThingStatesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ThingStateView	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ThingStateView** Parameters:
Name	Parameter	Data Type	Required
ThingId	form	Guid	No
OrganizationId	form	Guid	No
Properties	form	Dictionary<string, Object>	No
States	form	Dictionary<string, List<StateValueView>>	No
ChildThings	form	List<ThingStateView>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /thing/states HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutThingStates xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
  <States xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.Thing">
    <d2p1:StateValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:StateValue>
  </States>
  <ThingId>00000000-0000-0000-0000-000000000000</ThingId>
</PutThingStates>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ThingStatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.Thing">
    <d2p1:ChildThings>
      <d2p1:ThingStateView>
        <d2p1:ChildThings>
          <d2p1:ThingStateView>
            <d2p1:ChildThings>
              <d2p1:ThingStateView i:nil="true" />
            </d2p1:ChildThings>
            <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringanyType>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value />
              </d7p1:KeyValueOfstringanyType>
            </d2p1:Properties>
            <d2p1:States xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>
                  <d2p1:StateValueView>
                    <d2p1:Ts>0001-01-01T00:00:00</d2p1:Ts>
                    <d2p1:Value>String</d2p1:Value>
                  </d2p1:StateValueView>
                </d7p1:Value>
              </d7p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
            </d2p1:States>
            <d2p1:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
          </d2p1:ThingStateView>
        </d2p1:ChildThings>
        <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
        <d2p1:Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d2p1:Properties>
        <d2p1:States xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>
              <d2p1:StateValueView>
                <d2p1:Ts>0001-01-01T00:00:00</d2p1:Ts>
                <d2p1:Value>String</d2p1:Value>
              </d2p1:StateValueView>
            </d5p1:Value>
          </d5p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
        </d2p1:States>
        <d2p1:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
      </d2p1:ThingStateView>
    </d2p1:ChildThings>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:Properties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </d2p1:Properties>
    <d2p1:States xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d2p1:StateValueView>
            <d2p1:Ts>0001-01-01T00:00:00</d2p1:Ts>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:StateValueView>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
    </d2p1:States>
    <d2p1:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
  </Data>
</ThingStatesResponse>