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
NameDescriptionTypeAdditional 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": "f897cbfb-8bb3-448e-93c3-58e20e52dee8",
        "Name": "sample string 2",
        "OrganizationId": "496c3dc8-f549-481f-b195-df647cfe9297"
      },
      {
        "Id": "f897cbfb-8bb3-448e-93c3-58e20e52dee8",
        "Name": "sample string 2",
        "OrganizationId": "496c3dc8-f549-481f-b195-df647cfe9297"
      }
    ],
    "OrganizationStates": [
      {
        "Id": "c2becb03-4d1b-4434-b2ec-a406466d10aa",
        "Name": "sample string 2"
      },
      {
        "Id": "c2becb03-4d1b-4434-b2ec-a406466d10aa",
        "Name": "sample string 2"
      }
    ],
    "Id": "be6fc201-743e-4c4c-b22b-f56f15273aee",
    "Name": "sample string 2",
    "IconUrl": "sample string 3"
  },
  {
    "OrganizationRoles": [
      {
        "Id": "f897cbfb-8bb3-448e-93c3-58e20e52dee8",
        "Name": "sample string 2",
        "OrganizationId": "496c3dc8-f549-481f-b195-df647cfe9297"
      },
      {
        "Id": "f897cbfb-8bb3-448e-93c3-58e20e52dee8",
        "Name": "sample string 2",
        "OrganizationId": "496c3dc8-f549-481f-b195-df647cfe9297"
      }
    ],
    "OrganizationStates": [
      {
        "Id": "c2becb03-4d1b-4434-b2ec-a406466d10aa",
        "Name": "sample string 2"
      },
      {
        "Id": "c2becb03-4d1b-4434-b2ec-a406466d10aa",
        "Name": "sample string 2"
      }
    ],
    "Id": "be6fc201-743e-4c4c-b22b-f56f15273aee",
    "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>be6fc201-743e-4c4c-b22b-f56f15273aee</Id>
    <Name>sample string 2</Name>
    <OrganizationRoles>
      <RoleSimple>
        <Id>f897cbfb-8bb3-448e-93c3-58e20e52dee8</Id>
        <Name>sample string 2</Name>
        <OrganizationId>496c3dc8-f549-481f-b195-df647cfe9297</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>f897cbfb-8bb3-448e-93c3-58e20e52dee8</Id>
        <Name>sample string 2</Name>
        <OrganizationId>496c3dc8-f549-481f-b195-df647cfe9297</OrganizationId>
      </RoleSimple>
    </OrganizationRoles>
    <OrganizationStates>
      <StateSimple>
        <Id>c2becb03-4d1b-4434-b2ec-a406466d10aa</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>c2becb03-4d1b-4434-b2ec-a406466d10aa</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </OrganizationStates>
  </OrganizationDetail>
  <OrganizationDetail>
    <IconUrl>sample string 3</IconUrl>
    <Id>be6fc201-743e-4c4c-b22b-f56f15273aee</Id>
    <Name>sample string 2</Name>
    <OrganizationRoles>
      <RoleSimple>
        <Id>f897cbfb-8bb3-448e-93c3-58e20e52dee8</Id>
        <Name>sample string 2</Name>
        <OrganizationId>496c3dc8-f549-481f-b195-df647cfe9297</OrganizationId>
      </RoleSimple>
      <RoleSimple>
        <Id>f897cbfb-8bb3-448e-93c3-58e20e52dee8</Id>
        <Name>sample string 2</Name>
        <OrganizationId>496c3dc8-f549-481f-b195-df647cfe9297</OrganizationId>
      </RoleSimple>
    </OrganizationRoles>
    <OrganizationStates>
      <StateSimple>
        <Id>c2becb03-4d1b-4434-b2ec-a406466d10aa</Id>
        <Name>sample string 2</Name>
      </StateSimple>
      <StateSimple>
        <Id>c2becb03-4d1b-4434-b2ec-a406466d10aa</Id>
        <Name>sample string 2</Name>
      </StateSimple>
    </OrganizationStates>
  </OrganizationDetail>
</ArrayOfOrganizationDetail>