GET api/GetStructure/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Structure
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

CodeNumDepartment

string

None.

CodeCasParticulier

string

None.

Email

string

None.

ParentStructureId

integer

None.

Region

Region

None.

Department

Department

None.

Type

StructureTypes

None.

ChildrenIds

Collection of integer

None.

Status

StructureStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "CodeNumDepartment": "sample string 3",
  "CodeCasParticulier": "sample string 4",
  "Email": "sample string 5",
  "ParentStructureId": 6,
  "Region": {
    "Id": 1,
    "Name": "sample string 2",
    "Code": "sample string 3"
  },
  "Department": {
    "Id": 1,
    "Name": "sample string 2",
    "Code": "sample string 3"
  },
  "Type": {
    "Id": 0,
    "LongLabel": "sample string 1",
    "ShortLabel": "sample string 2",
    "Order": 3,
    "Registered": true
  },
  "ChildrenIds": [
    1,
    2
  ],
  "Status": 0
}

application/xml, text/xml

Sample:
<Structure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Models.Atrium">
  <ChildrenIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChildrenIds>
  <CodeCasParticulier>sample string 4</CodeCasParticulier>
  <CodeNumDepartment>sample string 3</CodeNumDepartment>
  <Department>
    <Code>sample string 3</Code>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Department>
  <Email>sample string 5</Email>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <ParentStructureId>6</ParentStructureId>
  <Region>
    <Code>sample string 3</Code>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Region>
  <Status>None</Status>
  <Type>
    <Id>None</Id>
    <LongLabel>sample string 1</LongLabel>
    <Order>3</Order>
    <Registered>true</Registered>
    <ShortLabel>sample string 2</ShortLabel>
  </Type>
</Structure>