GET PlanCare2Api/OrganizationStructure?applyPermissions={applyPermissions}

Gets active structure of organization.

Request Information

URI Parameters

Name	Description	Type	Additional information
applyPermissions	If false all entities will be returned. Otherwise only entities that the user has permission for.	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

List of OrganizationStructureEntities.

Collection of OrganizationStructureEntity

Name	Description	Type	Additional information
Id	Id of entity.	integer	-
Name	Name of entity.	string	-
Type	Type of entity.	OrganizationStructureEntityType	-
TypeName	Name of type of entity.	string	-
ParentId	Nullable id of parent entity.	integer	Nullable
Code	Code of entity.	string	-
CostCenter	Cost center of entity.	string	-
ExternalId	External identifier of entity.	string	-

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "Id": 1,
    "Name": "sample string 2",
    "Type": 0,
    "TypeName": "sample string 3",
    "ParentId": 1,
    "Code": "sample string 4",
    "CostCenter": "sample string 5",
    "ExternalId": "sample string 6"
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrganizationStructureEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.OrganizationStructure">
  <OrganizationStructureEntity>
    <Code>sample string 4</Code>
    <CostCenter>sample string 5</CostCenter>
    <ExternalId>sample string 6</ExternalId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ParentId>1</ParentId>
    <Type>None</Type>
    <TypeName>sample string 3</TypeName>
  </OrganizationStructureEntity>
  <OrganizationStructureEntity>
    <Code>sample string 4</Code>
    <CostCenter>sample string 5</CostCenter>
    <ExternalId>sample string 6</ExternalId>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ParentId>1</ParentId>
    <Type>None</Type>
    <TypeName>sample string 3</TypeName>
  </OrganizationStructureEntity>
</ArrayOfOrganizationStructureEntity>