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	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": "a761a42a-55ea-4f12-a306-b622f499d3d5",
        "Name": "sample string 2",
        "OrganizationId": "68807025-1b06-4482-9aad-c410e4c4816b"
      },
      {
        "Id": "a761a42a-55ea-4f12-a306-b622f499d3d5",
        "Name": "sample string 2",
        "OrganizationId": "68807025-1b06-4482-9aad-c410e4c4816b"
      }
    ],
    "OrganizationStates": [
      {
        "Id": "8781c419-18a4-48ba-a462-5a0d16b76a1f",
        "Name": "sample string 2"
      },
      {
        "Id": "8781c419-18a4-48ba-a462-5a0d16b76a1f",
        "Name": "sample string 2"
      }
    ],
    "Id": "e221a382-c270-400b-8dad-31b7488e52ef",
    "Name": "sample string 2",
    "IconUrl": "sample string 3"
  },
  {
    "OrganizationRoles": [
      {
        "Id": "a761a42a-55ea-4f12-a306-b622f499d3d5",
        "Name": "sample string 2",
        "OrganizationId": "68807025-1b06-4482-9aad-c410e4c4816b"
      },
      {
        "Id": "a761a42a-55ea-4f12-a306-b622f499d3d5",
        "Name": "sample string 2",
        "OrganizationId": "68807025-1b06-4482-9aad-c410e4c4816b"
      }
    ],
    "OrganizationStates": [
      {
        "Id": "8781c419-18a4-48ba-a462-5a0d16b76a1f",
        "Name": "sample string 2"
      },
      {
        "Id": "8781c419-18a4-48ba-a462-5a0d16b76a1f",
        "Name": "sample string 2"
      }
    ],
    "Id": "e221a382-c270-400b-8dad-31b7488e52ef",
    "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>e221a382-c270-400b-8dad-31b7488e52ef</Id>
    <Name>sample string 2</Name>
    <OrganizationRoles>
      <RoleSimple>
        <Id>a761a42a-55ea-4f12-a306-b622f499d3d5</Id>
        <Name>sample string 2</Name>
        <OrganizationId>68807025-1b06-4482-9aad-c410e4c4816b</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>a761a42a-55ea-4f12-a306-b622f499d3d5</Id>
        <Name>sample string 2</Name>
        <OrganizationId>68807025-1b06-4482-9aad-c410e4c4816b</OrganizationId>
      </RoleSimple>
    </OrganizationRoles>
    <OrganizationStates>
      <StateSimple>
        <Id>8781c419-18a4-48ba-a462-5a0d16b76a1f</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>8781c419-18a4-48ba-a462-5a0d16b76a1f</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </OrganizationStates>
  </OrganizationDetail>
  <OrganizationDetail>
    <IconUrl>sample string 3</IconUrl>
    <Id>e221a382-c270-400b-8dad-31b7488e52ef</Id>
    <Name>sample string 2</Name>
    <OrganizationRoles>
      <RoleSimple>
        <Id>a761a42a-55ea-4f12-a306-b622f499d3d5</Id>
        <Name>sample string 2</Name>
        <OrganizationId>68807025-1b06-4482-9aad-c410e4c4816b</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>a761a42a-55ea-4f12-a306-b622f499d3d5</Id>
        <Name>sample string 2</Name>
        <OrganizationId>68807025-1b06-4482-9aad-c410e4c4816b</OrganizationId>
      </RoleSimple>
    </OrganizationRoles>
    <OrganizationStates>
      <StateSimple>
        <Id>8781c419-18a4-48ba-a462-5a0d16b76a1f</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>8781c419-18a4-48ba-a462-5a0d16b76a1f</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </OrganizationStates>
  </OrganizationDetail>
</ArrayOfOrganizationDetail>