View file name LevelPassed.txt height 250 View file name LevelNotPassed.txt height 250 Table of Contents style Square
...
Background and strategic fit
The purpose of this Integration is to pull the Location information. This data can be further used while hitting other APIs)
(as request parameter). This document provides information on how the the end Users can consume the API.
If the user passes the RootLevel name as the parameter in the API Call, then the response will be as the JSON placed in the file "LevelPassed" .
If the user does not pass the RootLevel name as the parameter in the API call, then the response will be as the JSON placed in the file "LevelNotPassed".
Assumptions
- ProcessMAP system User permissions would not be considered while exposing the data
- Data will be shown in Readable JSON format
- User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
...
| Name | Description | Sample |
|---|---|---|
| Authorization | Represents the value of the authentication token. Allow multiple values: no. | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... |
| ConsumerId | Represents the value of the consumer id. Allow multiple values: no. | 2426 |
Response for the API Call without RootName as parameter
Sample:
{
"LocationId": "1234",
"LocationCode": "Test",
"LocationName": "Test",
"Address": "Test",
"Location Name": "sample string 2",
"Location Code": "sample string 3"City": "Test",
"State": "Test",
"Country": "Test",
"Zip": "765432"
}Response for the API Call with RootName as parameter
Sample:
{
"Level" : "By Geography/SL1/SL2",
"LocationId": "1234",
"LocationCode": "Test",
"LocationName": "Test",
"Address": "Test",
"City": "Test",
"State": "Test",
"Country": "Test",
"Zip": "765432"
}
Location Field List and Mapping
| Product Field Name | Description | Field Type and Size |
|---|---|---|
| Location Name | Represents location name | NVARCHAR(50) |
| Location Code | Represents location code | NVARCHAR(50) |
| LocationId | Represents Database LocationId | |
| Address | Represents Location Address | |
| City | Represents Location City | |
| State | Represents Location State | |
| Country | Represents Location Country | |
| Zip | Represents Location Zip | |
| Level | Represents the Level Hierarchy in flat format[when rootname is passed in parameter] |
Errors/Validation Messages
...