Viviot.Api

GetSmartSpace

The following routes are available for this service:
GET	/mobileb/smartspace	Gets a smartspace by Id or invalidates the request if the business user does not have active access.

**GetSmartSpace** Parameters:
Name	Parameter	Data Type	Required	Description
ThingId	query	string	Yes	Thing ID

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

**SmartSpaceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	ThingViewExtended	No

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

**ThingViewExtended** Parameters:
Name	Parameter	Data Type	Required
ImageUrl	form	string	No
ThingType	form	ThingTypeBasicView	No
ThingDefinition	form	ThingDefinitionView	No
UserAccesses	form	List<UserAccessView>	No
States	form	Dictionary<string, List<StateValueView>>	No
Properties	form	Dictionary<string, string>	No
ThingsByCategory	form	List<ThingCategoryView>	No
Organization	form	OrganizationDto	No

**ThingViewBasic** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
Order	form	int	No

**ThingTypeBasicView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
SysTypeName	form	string	No

**ThingDefinitionView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
OrganizationId	form	Guid	No
Name	form	string	No
Description	form	string	No
Properties	form	Dictionary<string, Object>	No

**UserAccessView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
UserId	form	int	No
BusinessUserId	form	int	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime?	No
ActiveFrom	form	DateTime	No
AccessCount	form	int?	No
TicketNumber	form	string	No
QueuePosition	form	int?	No
CanEnterWithTicket	form	bool	No
Permission	form	List<string>	No

**ThingCategoryView** Parameters:
Name	Parameter	Data Type	Required	Description
Things	form	List<ThingViewExtended>	No

**ThingCategoryBasicView** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	No

**OrganizationDto** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid?	No
Code	form	string	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.

GET /mobileb/smartspace HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml

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

<SmartSpaceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Mobile.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:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Order>0</d2p1:Order>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:ImageUrl>String</d2p1:ImageUrl>
    <d2p1:Organization xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Organization">
      <d3p1:Code>String</d3p1:Code>
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
    </d2p1:Organization>
    <d2p1:Properties 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: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:ThingDefinition>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
      <d2p1:Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Properties>
    </d2p1:ThingDefinition>
    <d2p1:ThingType>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:SysTypeName>String</d2p1:SysTypeName>
    </d2p1:ThingType>
    <d2p1:ThingsByCategory>
      <d2p1:ThingCategoryView>
        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Things>
          <d2p1:ThingViewExtended>
            <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Order>0</d2p1:Order>
            <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
            <d2p1:ImageUrl>String</d2p1:ImageUrl>
            <d2p1:Organization xmlns:d7p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Organization">
              <d7p1:Code>String</d7p1:Code>
              <d7p1:Id>00000000-0000-0000-0000-000000000000</d7p1:Id>
            </d2p1:Organization>
            <d2p1:Properties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </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:ThingDefinition>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
              <d2p1:Properties xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringanyType>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value />
                </d8p1:KeyValueOfstringanyType>
              </d2p1:Properties>
            </d2p1:ThingDefinition>
            <d2p1:ThingType>
              <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:SysTypeName>String</d2p1:SysTypeName>
            </d2p1:ThingType>
            <d2p1:ThingsByCategory>
              <d2p1:ThingCategoryView>
                <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
                <d2p1:Name>String</d2p1:Name>
                <d2p1:Things>
                  <d2p1:ThingViewExtended>
                    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
                    <d2p1:Name>String</d2p1:Name>
                    <d2p1:Order>0</d2p1:Order>
                    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
                    <d2p1:ImageUrl>String</d2p1:ImageUrl>
                    <d2p1:Organization xmlns:d11p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Organization">
                      <d11p1:Code>String</d11p1:Code>
                      <d11p1:Id>00000000-0000-0000-0000-000000000000</d11p1:Id>
                    </d2p1:Organization>
                    <d2p1:Properties xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:KeyValueOfstringstring>
                        <d11p1:Key>String</d11p1:Key>
                        <d11p1:Value>String</d11p1:Value>
                      </d11p1:KeyValueOfstringstring>
                    </d2p1:Properties>
                    <d2p1:States xmlns:d11p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                      <d11p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
                        <d11p1:Key>String</d11p1:Key>
                        <d11p1:Value>
                          <d2p1:StateValueView>
                            <d2p1:Ts>0001-01-01T00:00:00</d2p1:Ts>
                            <d2p1:Value>String</d2p1:Value>
                          </d2p1:StateValueView>
                        </d11p1:Value>
                      </d11p1:KeyValueOfstringArrayOfStateValueViewcYTd6it1>
                    </d2p1:States>
                    <d2p1:ThingDefinition>
                      <d2p1:Description>String</d2p1:Description>
                      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
                      <d2p1:Name>String</d2p1:Name>
                      <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
                      <d2p1:Properties xmlns:d12p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <d12p1:KeyValueOfstringanyType>
                          <d12p1:Key>String</d12p1:Key>
                          <d12p1:Value />
                        </d12p1:KeyValueOfstringanyType>
                      </d2p1:Properties>
                    </d2p1:ThingDefinition>
                    <d2p1:ThingType>
                      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
                      <d2p1:Name>String</d2p1:Name>
                      <d2p1:SysTypeName>String</d2p1:SysTypeName>
                    </d2p1:ThingType>
                    <d2p1:ThingsByCategory>
                      <d2p1:ThingCategoryView>
                        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
                        <d2p1:Name>String</d2p1:Name>
                        <d2p1:Things>
                          <d2p1:ThingViewExtended i:nil="true" />
                        </d2p1:Things>
                      </d2p1:ThingCategoryView>
                    </d2p1:ThingsByCategory>
                    <d2p1:UserAccesses xmlns:d11p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.UserAccess">
                      <d11p1:UserAccessView>
                        <d11p1:AccessCount>0</d11p1:AccessCount>
                        <d11p1:ActiveFrom>0001-01-01T00:00:00</d11p1:ActiveFrom>
                        <d11p1:BusinessUserId>0</d11p1:BusinessUserId>
                        <d11p1:CanEnterWithTicket>false</d11p1:CanEnterWithTicket>
                        <d11p1:Id>00000000-0000-0000-0000-000000000000</d11p1:Id>
                        <d11p1:Permission xmlns:d13p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                          <d13p1:string>String</d13p1:string>
                        </d11p1:Permission>
                        <d11p1:QueuePosition>0</d11p1:QueuePosition>
                        <d11p1:TicketNumber>String</d11p1:TicketNumber>
                        <d11p1:UserId>0</d11p1:UserId>
                        <d11p1:ValidFrom>0001-01-01T00:00:00</d11p1:ValidFrom>
                        <d11p1:ValidTo>0001-01-01T00:00:00</d11p1:ValidTo>
                      </d11p1:UserAccessView>
                    </d2p1:UserAccesses>
                  </d2p1:ThingViewExtended>
                </d2p1:Things>
              </d2p1:ThingCategoryView>
            </d2p1:ThingsByCategory>
            <d2p1:UserAccesses xmlns:d7p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.UserAccess">
              <d7p1:UserAccessView>
                <d7p1:AccessCount>0</d7p1:AccessCount>
                <d7p1:ActiveFrom>0001-01-01T00:00:00</d7p1:ActiveFrom>
                <d7p1:BusinessUserId>0</d7p1:BusinessUserId>
                <d7p1:CanEnterWithTicket>false</d7p1:CanEnterWithTicket>
                <d7p1:Id>00000000-0000-0000-0000-000000000000</d7p1:Id>
                <d7p1:Permission xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:string>String</d9p1:string>
                </d7p1:Permission>
                <d7p1:QueuePosition>0</d7p1:QueuePosition>
                <d7p1:TicketNumber>String</d7p1:TicketNumber>
                <d7p1:UserId>0</d7p1:UserId>
                <d7p1:ValidFrom>0001-01-01T00:00:00</d7p1:ValidFrom>
                <d7p1:ValidTo>0001-01-01T00:00:00</d7p1:ValidTo>
              </d7p1:UserAccessView>
            </d2p1:UserAccesses>
          </d2p1:ThingViewExtended>
        </d2p1:Things>
      </d2p1:ThingCategoryView>
    </d2p1:ThingsByCategory>
    <d2p1:UserAccesses xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Shared.UserAccess">
      <d3p1:UserAccessView>
        <d3p1:AccessCount>0</d3p1:AccessCount>
        <d3p1:ActiveFrom>0001-01-01T00:00:00</d3p1:ActiveFrom>
        <d3p1:BusinessUserId>0</d3p1:BusinessUserId>
        <d3p1:CanEnterWithTicket>false</d3p1:CanEnterWithTicket>
        <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
        <d3p1:Permission xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d3p1:Permission>
        <d3p1:QueuePosition>0</d3p1:QueuePosition>
        <d3p1:TicketNumber>String</d3p1:TicketNumber>
        <d3p1:UserId>0</d3p1:UserId>
        <d3p1:ValidFrom>0001-01-01T00:00:00</d3p1:ValidFrom>
        <d3p1:ValidTo>0001-01-01T00:00:00</d3p1:ValidTo>
      </d3p1:UserAccessView>
    </d2p1:UserAccesses>
  </Data>
</SmartSpaceResponse>