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

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.

Location Details

Request

GET papi/v1/locationoutbound/LocationInfo      or 

GET papi/v1/LocationOutbound/LocationInfo?level=LevelName  (PASSING level as OPTIONAL Parameter)

Ex: papi/v1/locationoutbound/LocationInfo       or 

    papi/v1/LocationOutbound/LocationInfo?level=LevelName   

Headers

Response

Sample:

{
    "Location Name": "sample string 2",
    "Location Code": "sample string 3"
}

Location Field List and Mapping

Errors/Validation Messages

Generic Error codes are given below.

HTTP ERROR 401

{
"HttpStatusCode": 401,
"HttpStatus": "Unauthorized",
"ErrorCode": 1030,
"ErrorMessage": "Invalid tenant."
}