PUT api/v7/TaxonomyLevels/{taxonomyLevelName}

Add or Update a taxonomy level record in the database.

Tables Impacted

OrgUnitLevel

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

The actual taxonomy level data.

TaxonomyLevel
NameDescriptionTypeRequired?Additional information
LevelName *

Corresponding organizational unit level name.

 string

Yes

String length: between 1 and 50, inclusive
LevelDescription *

Corresponding organizational unit level description.

 string

Yes

String length: between 1 and 50, inclusive
isLowestLevel

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

 boolean

No

None.
customerAuditDate

Last modified audit information

 date

No

None.

Request 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>

Response Information

Resource Description

A response containing an acknowledgement

HttpResponseMessage
NameDescriptionType
Version

Version
Content

HttpContent
StatusCode

HttpStatusCode
ReasonPhrase

string
Headers

Collection of Object
RequestMessage

HttpRequestMessage
IsSuccessStatusCode

boolean