Viviot.Api

<back to all web services

GetBusinessUserThings

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin, Receptionist
The following routes are available for this service:
GET/thingsGet nested thing or smart space list for a given organization to which a business user has access.
GetBusinessUserThings Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdquerystringNoOrganization ID
ThingIdquerystringNoThing ID to start the nested list from.
LoadOnlySmartSpacesquerybooleanNoFlag indicating that only smart spaces will be included into response.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
BusinessUserThingsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<BusinessUserThingsBaseResponse>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BusinessUserThingsBaseResponse Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdformGuidNo
ThingsformList<ThingView>No
ThingView Parameters:
NameParameterData TypeRequiredDescription
TypeformstringNo
DisplayTemplateformstringNo
PropertiesformDictionary<string, Object>No
StatesformDictionary<string, List<StateValueView>>No
TaskListsformList<TaskListView>No
ChildThingsformList<ThingView>No
ThingViewBasic Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
OrderformintNo
TaskListView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TaskListAssigneeformTaskListAssigneeViewNo
AccessTemplateIdformGuid?No
AccessTemplateNameformstringNo
PriorityformTaskListPriorityNo
StartformDateTimeNo
DeadlineformDateTime?No
CreatedformDateTimeNo
CategoriesformIEnumerable<string>No
RecurrenceConfigurationformstringNo
StatusformStatusNo
NameformstringNo
IncompleteReasonformIncompleteReason?No
IncompleteReasonDescriptionformstringNo
InstructionsformstringNo
TaskListAssigneeView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
TeamIdformGuid?No
TeamformTeamBasicViewNo
ShiftIdformGuid?No
ShiftformShiftViewNo
BusinessUserformBusinessUserBasicViewNo
BusinessUserIdformint?No
TeamBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
ShiftView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
TeamIdformGuid?No
StartTimeOffsetformintNo
EndTimeOffsetformintNo
StartDateformDateTime?No
EndDateformDateTime?No
ShiftMembersformIReadOnlyCollection<ShiftMemberView>No
ShiftMemberView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
BusinessUserIdformintNo
ShiftIdformGuidNo
BusinessUserformBusinessUserBasicViewNo
BusinessUserBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
TaskListPriority Enum:
NameValue
None0
VeryLow10
Low20
Medium30
High40
VeryHigh50
Critical60
Status Enum:
NameValue
ToDo0
InProgress10
Incomplete30
Done40
IncompleteReason Enum:
NameValue
ResourcesMissing10
PrioritySwitch20
GuestDeclined30
FeelingUnwell40
Other50

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

HTTP + CSV

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

GET /things HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":[{"organizationId":"00000000000000000000000000000000","things":[{"type":"String","displayTemplate":"String","properties":{"String":{}},"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskLists":[{"id":"00000000000000000000000000000000","name":"String","start":-62135596800000,"deadline":-62135596800000,"created":-62135596800000,"priority":0,"status":0,"recurrenceConfiguration":"String","accessTemplateId":"00000000000000000000000000000000","accessTemplateName":"String","incompleteReason":0,"incompleteReasonDescription":"String","instructions":"String","businessUserAccessId":"00000000000000000000000000000000","tasks":[{"id":"00000000000000000000000000000000","name":"String","description":"String","completeWithTag":false,"nfcCode":"String","taskType":0,"order":0,"taskStatus":0,"taskListId":"00000000000000000000000000000000"}],"smartspaceIds":["00000000000000000000000000000000"],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskListAssigneeId":"00000000000000000000000000000000","taskListAssignee":{"id":"00000000000000000000000000000000","teamId":"00000000000000000000000000000000","team":{"id":"00000000000000000000000000000000","name":"String"},"shiftId":"00000000000000000000000000000000","shift":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","teamId":"00000000000000000000000000000000","startTimeOffset":0,"endTimeOffset":0,"startDate":-62135596800000,"endDate":-62135596800000},"businessUser":{"id":0,"name":"String"},"businessUserId":0}}],"things":[{"type":"String","displayTemplate":"String","properties":{"String":{}},"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskLists":[{"id":"00000000000000000000000000000000","name":"String","start":-62135596800000,"deadline":-62135596800000,"created":-62135596800000,"priority":0,"status":0,"recurrenceConfiguration":"String","accessTemplateId":"00000000000000000000000000000000","accessTemplateName":"String","incompleteReason":0,"incompleteReasonDescription":"String","instructions":"String","businessUserAccessId":"00000000000000000000000000000000","tasks":[{"id":"00000000000000000000000000000000","name":"String","description":"String","completeWithTag":false,"nfcCode":"String","taskType":0,"order":0,"taskStatus":0,"taskListId":"00000000000000000000000000000000"}],"smartspaceIds":["00000000000000000000000000000000"],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskListAssigneeId":"00000000000000000000000000000000","taskListAssignee":{"id":"00000000000000000000000000000000","teamId":"00000000000000000000000000000000","team":{"id":"00000000000000000000000000000000","name":"String"},"shiftId":"00000000000000000000000000000000","shift":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","teamId":"00000000000000000000000000000000","startTimeOffset":0,"endTimeOffset":0,"startDate":-62135596800000,"endDate":-62135596800000},"businessUser":{"id":0,"name":"String"},"businessUserId":0}}],"things":[{"type":"String","displayTemplate":"String","properties":{"String":{}},"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskLists":[{"id":"00000000000000000000000000000000","name":"String","start":-62135596800000,"deadline":-62135596800000,"created":-62135596800000,"priority":0,"status":0,"recurrenceConfiguration":"String","accessTemplateId":"00000000000000000000000000000000","accessTemplateName":"String","incompleteReason":0,"incompleteReasonDescription":"String","instructions":"String","businessUserAccessId":"00000000000000000000000000000000","tasks":[{"id":"00000000000000000000000000000000","name":"String","description":"String","completeWithTag":false,"nfcCode":"String","taskType":0,"order":0,"taskStatus":0,"taskListId":"00000000000000000000000000000000"}],"smartspaceIds":["00000000000000000000000000000000"],"states":{"String":[{"ts":-62135596800000,"value":"String"}]},"taskListAssigneeId":"00000000000000000000000000000000","taskListAssignee":{"id":"00000000000000000000000000000000","teamId":"00000000000000000000000000000000","team":{"id":"00000000000000000000000000000000","name":"String"},"shiftId":"00000000000000000000000000000000","shift":{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","teamId":"00000000000000000000000000000000","startTimeOffset":0,"endTimeOffset":0,"startDate":-62135596800000,"endDate":-62135596800000},"businessUser":{"id":0,"name":"String"},"businessUserId":0}}],"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","order":0}],"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","name":"String","order":0}],"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"}}}