Background and strategic fit

The purpose of this Integration is to pull over Level Hierarchy to support our growing customer base to analyze the data they are entering through the ProcessMAP solution. 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

• ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access Personal Information

• User would have to input single Level (e.g. By Division) each time to consume that Level 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

Implementation : 

AUTHENTICATION URL DETAILS [  Base URL with Auth EndPoint ] 

Please note that the above Auth Token expires after every 120 minutes.

BASE URL FOR RESPECTIVE API CALLS : 

Request

GET papi/v1/leveloutbound/LevelInfo?level={level}

Ex: papi/v1/leveloutbound/LevelInfo?level=By Division

URI Parameters

Level is to be passed as parameters. Data will be returned based on Level only.

Sample Parameters

Open

Headers

Sample JSON

[
{
"LevelName": "Sample String",
"LevelId": INT,
"ParentLevelId": INT,
"ParentLevel": "Sample String",
"Depth": INT
},
{
"LevelName": "Sample String",
"LevelId": INT,
"ParentLevelId": INT,
"ParentLevel": "Sample String",
"Depth": INT
},
{
"LevelName": "Sample String",
"LevelId": INT,
"ParentLevelId": INT,
"ParentLevel": "Sample String",
"Depth": INT
}
]

Level Field List

Errors/Validation Messages

Generic Error codes are given below.

Open

HTTP ERROR 401

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

If the level given is invalid:

{
"Message": "Invalid level"
}