Viviot.Api

<back to all web services

GetSmartSpace

Requires Authentication
The following routes are available for this service:
GET/mobileb/smartspaceGets a smartspace by Id or invalidates the request if the business user does not have active access.
GetSmartSpace Parameters:
NameParameterData TypeRequiredDescription
ThingIdquerystringYesThing ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
SmartSpaceResponse Parameters:
NameParameterData TypeRequiredDescription
DataformThingViewExtendedNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ThingViewExtended Parameters:
NameParameterData TypeRequiredDescription
ImageUrlformstringNo
ThingTypeformThingTypeBasicViewNo
ThingDefinitionformThingDefinitionViewNo
UserAccessesformList<UserAccessView>No
StatesformDictionary<string, List<StateValueView>>No
PropertiesformDictionary<string, string>No
ThingsByCategoryformList<ThingCategoryView>No
OrganizationformOrganizationDtoNo
ThingViewBasic Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
OrderformintNo
ThingTypeBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
SysTypeNameformstringNo
ThingDefinitionView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
DescriptionformstringNo
PropertiesformDictionary<string, Object>No
UserAccessView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
UserIdformintNo
BusinessUserIdformintNo
ValidFromformDateTimeNo
ValidToformDateTime?No
ActiveFromformDateTimeNo
AccessCountformint?No
TicketNumberformstringNo
QueuePositionformint?No
CanEnterWithTicketformboolNo
PermissionformList<string>No
ThingCategoryView Parameters:
NameParameterData TypeRequiredDescription
ThingsformList<ThingViewExtended>No
ThingCategoryBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
OrganizationDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
CodeformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"imageUrl":"String","thingType":{"id":"00000000000000000000000000000000","name":"String","sysTypeName":"String"},"thingDefinition":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","description":"String","properties":{"String":{}}},"userAccesses":[{"id":"00000000000000000000000000000000","userId":0,"businessUserId":0,"validFrom":-62135596800000,"validTo":-62135596800000,"activeFrom":-62135596800000,"accessCount":0,"ticketNumber":"String","queuePosition":0,"canEnterWithTicket":false,"permission":["String"]}],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"properties":{"String":"String"},"thingsByCategory":[{"things":[{"imageUrl":"String","thingType":{"id":"00000000000000000000000000000000","name":"String","sysTypeName":"String"},"thingDefinition":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","description":"String","properties":{"String":{}}},"userAccesses":[{"id":"00000000000000000000000000000000","userId":0,"businessUserId":0,"validFrom":-62135596800000,"validTo":-62135596800000,"activeFrom":-62135596800000,"accessCount":0,"ticketNumber":"String","queuePosition":0,"canEnterWithTicket":false,"permission":["String"]}],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"properties":{"String":"String"},"thingsByCategory":[{"things":[{"imageUrl":"String","thingType":{"id":"00000000000000000000000000000000","name":"String","sysTypeName":"String"},"thingDefinition":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","description":"String","properties":{"String":{}}},"userAccesses":[{"id":"00000000000000000000000000000000","userId":0,"businessUserId":0,"validFrom":-62135596800000,"validTo":-62135596800000,"activeFrom":-62135596800000,"accessCount":0,"ticketNumber":"String","queuePosition":0,"canEnterWithTicket":false,"permission":["String"]}],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"properties":{"String":"String"},"thingsByCategory":[{"things":[{}],"id":"00000000000000000000000000000000","name":"String"}],"organization":{"id":"00000000000000000000000000000000","code":"String"},"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","order":0}],"id":"00000000000000000000000000000000","name":"String"}],"organization":{"id":"00000000000000000000000000000000","code":"String"},"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","order":0}],"id":"00000000000000000000000000000000","name":"String"}],"organization":{"id":"00000000000000000000000000000000","code":"String"},"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","order":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}