Background and strategic fit
The purpose of this Integration is to pull over Location information that can be used in other APIs as request. This document provides information on how to consume the API's by the end Users.
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
Location
Location Details
Request
GET papi/v1/locationoutbound/LocationInfo
Ex: papi/v1/locationoutbound/LocationInfo
Headers
| Name | Description | Sample |
|---|---|---|
| Authorization | Represents the value of the authentication token. Allow multiple values: no. | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... |
| ConsumerId | Represents the value of the consumer id. Allow multiple values: no. | 2426 |
Response
Sample:
{
"Location Id": 1,
"Location Name": "sample string 2",
"Location Code": "sample string 3"
}Location Field List and Mapping
| Product Field Name | Description | Field Type and Size |
|---|---|---|
| Location Id | Represents the id of a location | INT |
| Location Name | Represents location name | NVARCHAR(50) |
| Location Code | Represents location code | NVARCHAR(50) |
Errors/Validation Messages
Generic Error codes are given below.
HTTP ERROR 401
{
"HttpStatusCode": 401,
"HttpStatus": "Unauthorized",
"ErrorCode": 1030,
"ErrorMessage": "Invalid tenant."
}