Viviot.Api

GetOrganization

The following routes are available for this service:
GET	/organization	Gets an organization assigned to a business user with all corresponding sub-organizations (optional).

**GetOrganization** Parameters:
Name	Parameter	Data Type	Required	Description
OrganizationId	query	string	No	Organization Id for which to get list of sub-organizations (optioanl).
LoadSubOrganizations	query	boolean	No	Include sub-organizations in organization response data.

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

**OrganizationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	OrganizationBasicView	No

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

**OrganizationBasicView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Type	form	OrganizationType	No
SubOrganizations	form	List<OrganizationBasicView>	No

**OrganizationType** Enum:
Name	Value
Unknown	0
Admin	10
Tenant	20
Location	30

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

{"data":{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{"id":"00000000000000000000000000000000","name":"String","type":0,"organizations":[{}]}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}