GET PlanCare2Api/DynamicData/OEStructure?parentOrganizationEntityId={parentOrganizationEntityId}

Retreives the organization structure beneath a specific organization entity id

Request Information

URI Parameters

Name Description Type Additional information
parentOrganizationEntityId

The identifier of the organization entity from where the structure will be displayed

integer

Required

Body Parameters

None.

Response Information

Resource Description

No information.

Collection of OEStructureResult
Name Description Type Additional information
Parentorganizationentityid

The identifier of the parent organization entity

integer

Nullable

Organizationentityid

The identity of de organization entity

integer

Nullable

Organizationentityname

The name of de organization entity

string

-

Organizationentitytypeid

The identifier of de organization entity type

string

-

Organizationentitytype

The type of de organization entity

string

-

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "Parentorganizationentityid": 1,
    "Organizationentityid": 1,
    "Organizationentityname": "sample string 1",
    "Organizationentitytypeid": "sample string 2",
    "Organizationentitytype": "sample string 3"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDynamicDataController.OEStructureResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Controllers">
  <DynamicDataController.OEStructureResult>
    <Organizationentityid>1</Organizationentityid>
    <Organizationentityname>sample string 1</Organizationentityname>
    <Organizationentitytype>sample string 3</Organizationentitytype>
    <Organizationentitytypeid>sample string 2</Organizationentitytypeid>
    <Parentorganizationentityid>1</Parentorganizationentityid>
  </DynamicDataController.OEStructureResult>
  <DynamicDataController.OEStructureResult>
    <Organizationentityid>1</Organizationentityid>
    <Organizationentityname>sample string 1</Organizationentityname>
    <Organizationentitytype>sample string 3</Organizationentitytype>
    <Organizationentitytypeid>sample string 2</Organizationentitytypeid>
    <Parentorganizationentityid>1</Parentorganizationentityid>
  </DynamicDataController.OEStructureResult>
</ArrayOfDynamicDataController.OEStructureResult>