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
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
- The Level in the output will be shown only if the end user passes the Top RootNode name in the parameter.
- If the user passes any intermediate Level as Parameter or does not pass anything, then the "Level" property in output will be NULL. This is because the system allows for having sublevels under different structure with same name. So the hierarchy can be multiple in that case.
User Interaction
Users can fetch all location information at once by hitting the endpoint. There is also an optional parameter LEVEL which can be passed to the API and only Location codes mapped to that LEVEL would be shown in the JSON response.
...
{
"Level: : NULL,
"LocationId": "1234",
"LocationCode": "Test",
"LocationName": "Test",
"Address": "Test",
"City": "Test",
"State": "Test",
"Country": "Test",
"Zip": "765432"
}
{
"Level: : NULL,
"LocationId": "6789",
"LocationCode": "Test1",
"LocationName": "Test1",
"Address": "Test1",
"City": "Test1",
"State": "Test1",
"Country": "Test1",
"Zip": "765432"
}Response for the API Call with RootName as parameter
...
{
"Level" : "By Geography/SL1/SL2",
"LocationId": "1234",
"LocationCode": "TestTrainingLocation",
"LocationName": "TestTrainingLocation",
"Address": "Test",
"City": "Test",
"State": "Test",
"Country": "Test",
"Zip": "765432"
}
{
"Level" : "By Geography/SL1/SL2/SL3",
"LocationId": "4567",
"LocationCode": "TrainingLocation1",
"LocationName": "TrainingLocation1",
"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] |
...