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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrganizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.Organization">
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:SubOrganizations>
      <d2p1:OrganizationBasicView>
        <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:SubOrganizations>
          <d2p1:OrganizationBasicView>
            <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:SubOrganizations>
              <d2p1:OrganizationBasicView i:nil="true" />
            </d2p1:SubOrganizations>
            <d2p1:Type>Unknown</d2p1:Type>
          </d2p1:OrganizationBasicView>
        </d2p1:SubOrganizations>
        <d2p1:Type>Unknown</d2p1:Type>
      </d2p1:OrganizationBasicView>
    </d2p1:SubOrganizations>
    <d2p1:Type>Unknown</d2p1:Type>
  </Data>
</OrganizationResponse>