...

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" property in the output JSON will be shown only if the end user passes the Top RootNode name in the parameterhave the levels and sublevels separated by a "/" till the last level where the location belongs to.
• If the user passes does not pass 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 caseName as the parameter then all locations of the system will be displayed with the Level Information ,In this case suppose a location is mapped to different levels under different top root level then any one of the level hierarchy will be displayed for that location.
• If the user passes any level name as the parameter, then all locations under that level will be displayed.

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.

...

Response for the API Call without RootName as parameter 

Sample:

{
    "Level:     : NULL "By Geography/By Country",
    "LocationId": "1234",
    "LocationCode": "Test",
    "LocationName": "Test",
    "Address": "Test",
    "City": "Test",
    "State": "Test",
    "Country": "Test",
    "Zip": "765432"    
    
}
{
"Level: : NULL "By Geography/By Country",
"LocationId": "6789",
"LocationCode": "Test1",
"LocationName": "Test1",
"Address": "Test1",
"City": "Test1",
"State": "Test1",
"Country": "Test1",
"Zip": "765432" 
}

...

...