Viviot.Api

<back to all web services

GetOrganizations

Requires Authentication
The following routes are available for this service:
GET/mobileb/organizationsGets all organizations available to a mobile user via their business association.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
OrganizationsResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<OrganizationBasicView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrganizationBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TypeformOrganizationTypeNo
SubOrganizationsformList<OrganizationBasicView>No
OrganizationType Enum:
NameValue
Unknown0
Admin10
Tenant20
Location30

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 /mobileb/organizations HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"data":[{"id":"00000000000000000000000000000000","name":"String","code":"String","parentId":"00000000000000000000000000000000"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}