GET api/v7/TaxonomyLevels/{taxonomyLevelName}

Returns a taxonomy level record from the database.

Request Information

URI Parameters

NameDescriptionTypeRequired?Additional information
taxonomyLevelName *

Name of the taxonomy level record used for location in the database.

string

Yes

None.

Body Parameters

None.

Response Information

Resource Description

A response containing an acknowledgement and the requested taxonomy level information.

TaxonomyLevel
NameDescriptionType
LevelName

Corresponding organizational unit level name.

string
LevelDescription

Corresponding organizational unit level description.

string
isLowestLevel

Flag indicating whether the level is the lowest level in the taxonomy

boolean
customerAuditDate

Last modified audit information

date

Response Formats

application/json, text/json

Sample:
{
  "LevelName": "sample string 1",
  "LevelDescription": "sample string 2",
  "isLowestLevel": true,
  "customerAuditDate": "2018-01-01T00:00:00"
}

application/xml, text/xml

Sample:
<TaxonomyLevel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LevelName>sample string 1</LevelName>
  <LevelDescription>sample string 2</LevelDescription>
  <isLowestLevel>true</isLowestLevel>
  <customerAuditDate>2018-01-01T00:00:00</customerAuditDate>
</TaxonomyLevel>