Viviot.Api

<back to all web services

GetOrganization

Requires Authentication
The following routes are available for this service:
GET/organizationGets an organization assigned to a business user with all corresponding sub-organizations (optional).
GetOrganization Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdquerystringNoOrganization Id for which to get list of sub-organizations (optioanl).
LoadSubOrganizationsquerybooleanNoInclude sub-organizations in organization response data.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformOrganizationBasicViewNo
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 /organization HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'OrganizationResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)