...

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

• 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

...

{
"LocationDetails" :[
"ImmediateLevelID": [
"1001",
"1003"
],
"LocationId": "1234",
"LocationCode": "Test",
"LocationName": "Test",
"CompanyCode" : "TestCode",
"Address": "Test",
"Country": "Test",
"State/Province": "Test",
"City": "Test",
"County" : "TestCounty",
"Postal/ZipCode": "765432",
"LocationStatus" : "",
"BusinessType" : "TestBusinessType",
"OperationType" : "TestOperationType",
"IndustryDescription" :"TestDescription",
"Comments" :"TestComments"
}
},

Errors/Validation Messages

...