GET api/Tree?treeName={treeName}

Get tree list by tree name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
treeName

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Tree
NameDescriptionTypeAdditional information
TreeId

integer

None.

TreeDescription

string

None.

TreeName

string

None.

ParentTreeId

integer

None.

TreeNodeList

Collection of TreeNode

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "TreeId": 1,
    "TreeDescription": "sample string 2",
    "TreeName": "sample string 3",
    "ParentTreeId": 4,
    "TreeNodeList": [
      {
        "TreeId": 1,
        "RegionId": 2,
        "LocationId": 3,
        "LocationDescription": "sample string 4",
        "LocationName": "sample string 5"
      },
      {
        "TreeId": 1,
        "RegionId": 2,
        "LocationId": 3,
        "LocationDescription": "sample string 4",
        "LocationName": "sample string 5"
      }
    ]
  },
  {
    "TreeId": 1,
    "TreeDescription": "sample string 2",
    "TreeName": "sample string 3",
    "ParentTreeId": 4,
    "TreeNodeList": [
      {
        "TreeId": 1,
        "RegionId": 2,
        "LocationId": 3,
        "LocationDescription": "sample string 4",
        "LocationName": "sample string 5"
      },
      {
        "TreeId": 1,
        "RegionId": 2,
        "LocationId": 3,
        "LocationDescription": "sample string 4",
        "LocationName": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfTree xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RSMCP.Entities">
  <Tree>
    <ParentTreeId>4</ParentTreeId>
    <TreeDescription>sample string 2</TreeDescription>
    <TreeId>1</TreeId>
    <TreeName>sample string 3</TreeName>
    <TreeNodeList>
      <TreeNode>
        <LocationDescription>sample string 4</LocationDescription>
        <LocationId>3</LocationId>
        <LocationName>sample string 5</LocationName>
        <RegionId>2</RegionId>
        <TreeId>1</TreeId>
      </TreeNode>
      <TreeNode>
        <LocationDescription>sample string 4</LocationDescription>
        <LocationId>3</LocationId>
        <LocationName>sample string 5</LocationName>
        <RegionId>2</RegionId>
        <TreeId>1</TreeId>
      </TreeNode>
    </TreeNodeList>
  </Tree>
  <Tree>
    <ParentTreeId>4</ParentTreeId>
    <TreeDescription>sample string 2</TreeDescription>
    <TreeId>1</TreeId>
    <TreeName>sample string 3</TreeName>
    <TreeNodeList>
      <TreeNode>
        <LocationDescription>sample string 4</LocationDescription>
        <LocationId>3</LocationId>
        <LocationName>sample string 5</LocationName>
        <RegionId>2</RegionId>
        <TreeId>1</TreeId>
      </TreeNode>
      <TreeNode>
        <LocationDescription>sample string 4</LocationDescription>
        <LocationId>3</LocationId>
        <LocationName>sample string 5</LocationName>
        <RegionId>2</RegionId>
        <TreeId>1</TreeId>
      </TreeNode>
    </TreeNodeList>
  </Tree>
</ArrayOfTree>