GET api/organizations/details
Get all Organizations this user has access to with their detailed roles and states
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of OrganizationDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| OrganizationRoles | Collection of RoleSimple |
None. |
|
| OrganizationStates | Collection of StateSimple |
None. |
|
| Id | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| IconUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OrganizationRoles": [
{
"Id": "31771fa1-0009-46f5-bb6e-4ff853f6bddf",
"Name": "sample string 2",
"OrganizationId": "1dcc21e0-aff9-4ad8-9de4-2806b944ebef"
},
{
"Id": "31771fa1-0009-46f5-bb6e-4ff853f6bddf",
"Name": "sample string 2",
"OrganizationId": "1dcc21e0-aff9-4ad8-9de4-2806b944ebef"
}
],
"OrganizationStates": [
{
"Id": "f5edf52b-ddc5-49d5-85d1-e9d6d0375578",
"Name": "sample string 2"
},
{
"Id": "f5edf52b-ddc5-49d5-85d1-e9d6d0375578",
"Name": "sample string 2"
}
],
"Id": "8abcba3a-ff40-4e84-a8eb-71d63b9106c5",
"Name": "sample string 2",
"IconUrl": "sample string 3"
},
{
"OrganizationRoles": [
{
"Id": "31771fa1-0009-46f5-bb6e-4ff853f6bddf",
"Name": "sample string 2",
"OrganizationId": "1dcc21e0-aff9-4ad8-9de4-2806b944ebef"
},
{
"Id": "31771fa1-0009-46f5-bb6e-4ff853f6bddf",
"Name": "sample string 2",
"OrganizationId": "1dcc21e0-aff9-4ad8-9de4-2806b944ebef"
}
],
"OrganizationStates": [
{
"Id": "f5edf52b-ddc5-49d5-85d1-e9d6d0375578",
"Name": "sample string 2"
},
{
"Id": "f5edf52b-ddc5-49d5-85d1-e9d6d0375578",
"Name": "sample string 2"
}
],
"Id": "8abcba3a-ff40-4e84-a8eb-71d63b9106c5",
"Name": "sample string 2",
"IconUrl": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfOrganizationDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XCapture.DTO">
<OrganizationDetail>
<IconUrl>sample string 3</IconUrl>
<Id>8abcba3a-ff40-4e84-a8eb-71d63b9106c5</Id>
<Name>sample string 2</Name>
<OrganizationRoles>
<RoleSimple>
<Id>31771fa1-0009-46f5-bb6e-4ff853f6bddf</Id>
<Name>sample string 2</Name>
<OrganizationId>1dcc21e0-aff9-4ad8-9de4-2806b944ebef</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>31771fa1-0009-46f5-bb6e-4ff853f6bddf</Id>
<Name>sample string 2</Name>
<OrganizationId>1dcc21e0-aff9-4ad8-9de4-2806b944ebef</OrganizationId>
</RoleSimple>
</OrganizationRoles>
<OrganizationStates>
<StateSimple>
<Id>f5edf52b-ddc5-49d5-85d1-e9d6d0375578</Id>
<Name>sample string 2</Name>
</StateSimple>
<StateSimple>
<Id>f5edf52b-ddc5-49d5-85d1-e9d6d0375578</Id>
<Name>sample string 2</Name>
</StateSimple>
</OrganizationStates>
</OrganizationDetail>
<OrganizationDetail>
<IconUrl>sample string 3</IconUrl>
<Id>8abcba3a-ff40-4e84-a8eb-71d63b9106c5</Id>
<Name>sample string 2</Name>
<OrganizationRoles>
<RoleSimple>
<Id>31771fa1-0009-46f5-bb6e-4ff853f6bddf</Id>
<Name>sample string 2</Name>
<OrganizationId>1dcc21e0-aff9-4ad8-9de4-2806b944ebef</OrganizationId>
</RoleSimple>
<RoleSimple>
<Id>31771fa1-0009-46f5-bb6e-4ff853f6bddf</Id>
<Name>sample string 2</Name>
<OrganizationId>1dcc21e0-aff9-4ad8-9de4-2806b944ebef</OrganizationId>
</RoleSimple>
</OrganizationRoles>
<OrganizationStates>
<StateSimple>
<Id>f5edf52b-ddc5-49d5-85d1-e9d6d0375578</Id>
<Name>sample string 2</Name>
</StateSimple>
<StateSimple>
<Id>f5edf52b-ddc5-49d5-85d1-e9d6d0375578</Id>
<Name>sample string 2</Name>
</StateSimple>
</OrganizationStates>
</OrganizationDetail>
</ArrayOfOrganizationDetail>