PUT api/v7/HierarchyLevels
Add or Update Hierarchy Level. Accepts HierarchyLevelCode and LevelName and return a response containing an acknowledgement. If the record exists than it updates; If the record does not exist than the API inserts the record.
Tables Impacted
HierarchyLevel
Request Information
URI Parameters
None.
Body Parameters
Hierarchy attributes (HierarchyLevelCode and LevelName) to update the Hierarchy record
Hierarchy Level| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| hierarchyLevelCode * |
Hierarchy Level code |
string |
Yes |
String length: between 1 and 24, inclusive |
| levelName * |
Hierarchy Level Name |
string |
Yes |
String length: between 1 and 50, inclusive |
| customerAuditDate |
Last modified audit information |
date |
No |
None. |
Request Formats
application/json, text/json
Sample:
{
"hierarchyLevelCode": "sample string 1",
"levelName": "sample string 2",
"customerAuditDate": "2018-01-01T00:00:00"
}
application/xml, text/xml
Sample:
<HierarchyLevelDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <hierarchyLevelCode>sample string 1</hierarchyLevelCode> <levelName>sample string 2</levelName> <customerAuditDate>2018-01-01T00:00:00</customerAuditDate> </HierarchyLevelDto>
Response Information
Resource Description
Returns a HTTPResponse Message stating the success/failure of API Action
HttpResponseMessage| Name | Description | Type |
|---|---|---|
| Version | Version | |
| Content | HttpContent | |
| StatusCode | HttpStatusCode | |
| ReasonPhrase | string | |
| Headers | Collection of Object | |
| RequestMessage | HttpRequestMessage | |
| IsSuccessStatusCode | boolean |