...

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 have the levels and sublevels separated by a "/" till the last level where the location belongs to.
• If the user does not pass any Level Name as the parameter then all locations of the system will be displayed .
• If the user passes any level name as the parameter, then all locations under that level will be displayed.
• If any level available in multiple categories and mapped to a single location, display anyone mapping enterprise heiarchy of the location.

User Interaction

...

• Org API will give the complete Enterprise hierarchy in a flat format. The location API will provide all location details in a flat format. The linkage between two APIs is the ImmediateLevelID field in the Location API. Using that the complete hierarchy can be achieved.

• Only Level information is shown with ID. No location information. For mapping to location, we need to call location API which has ImmediateLevelID that can be mapped with the LevelID in this API & further self-joined to retrieve the complete hierarchy

User Interaction

Location Details

Request

GET papi/v1/locationoutbound/LocationInfo      or 

...

Response for the API Call without RootName as parameter 

Sample:

{
    "Level:     : "By Geography/By Country",
    "LocationId": "1234",
    "LocationCode": "Test",
    "LocationName": "Test",
    "Address": "Test",
    "City": "Test",
    "State": "Test",
    "Country": "Test",
    "Zip": "765432"    
    
}
{
"Level: : "By Geography/By Country",
"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 

Sample:

{  
    "Level" : "By Geography/SL1/SL2",
    "LocationId": "1234",
    "LocationCode": "TrainingLocation",
    "LocationName": "TrainingLocation",
    "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" 
}

Org Structure

Location Field List and Mapping

Errors/Validation Messages

...