Background and strategic fit:
The purpose of this Integration is to pull over Audit Program and related data (Questionnaire, response, score, findings, action items, BMP, Notes, Synopsis etc...) to support our growing customer base to analyze the outcome of audit they are performing through the ProcessMAP solution.
Assumptions:
- ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access the data this API contains
- This includes confidential Audit Programs as well (Program Level permission)
- User accessing this endpoint through a valid Token & ConsumerId, provided by ProcessMAP, will have access to complete data
- User would have to input single Location Code (e.g. Westlake) each time to consume that Location data
- Data to be accessed with a limitation of 2 years duration at a time to avoid any performance issues.
- Data will be shown in Readable JSON format
- DATETIME, INT and FLOAT data will be shown as NULL when there is no data
- The date that is being shown in response is in EST Date time format ONLY
- Attachments will not be part of the JSON
User Interaction:
AUTHENTICATION URL DETAILS [ Base URL with Auth EndPoint ]
Environment | Auth URL |
|---|---|
| UAT | https://integrationsvc.uat.pmapconnect.com/product/papi/v1/auth |
| Production | https://integrationsvc.processmap.com/product/papi/v1/auth |
Please note that the above Auth Token expires after every 120 minutes.
BASE URL+ Endpoint FOR RESPECTIVE API CALLS:
URI Parameters
- Location Code, Date From, Date To and Last Synced Date are to be passed as parameters.
- Date From and Date To are required when Last Synced Date is not provided.
- Date From and Date To are optional when Last Synced Date is provided.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Location Code | Represents the unique code of location for which Audit Programs should be returned | string | Required |
| Date From | Represents the starting date from when Audit Programs to be returned based on Audit Start Date | date | Required. Optional when "Last Synced Date" is provided |
| Date To | Represents the ending date till when Audit Programs to be returned based on Audit Start Date | date | Required. Optional when "Last Synced Date" is provided |
| Last Synced Date | Represents the data from Audit created date or Audit modified date (Audit Details or any related data from the Audit) | date | Optional |
Sample Parameters
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 |
Sample JSON
Field List:
Poonam Chandak - Take it from TSD
Errors/Validation Messages
Generic Error codes are given below.
HTTP ERROR 401
{
"HttpStatusCode": 401,
"HttpStatus": "Unauthorized",
"ErrorCode": 1030,
"ErrorMessage": "Invalid tenant."
}
If the location code given is invalid:
{
"Message": "Invalid Location Code"
}
(When FromDate, ToDate and LastSyncedDate are empty) or (FromDate, ToDate and LastSyncedDate are given in incorrect format of DD-MM-YYYY)
{
"Message": "Date From or Date To should not be empty"
}
When FromDate is greater than ToDate and LastSyncedDate is empty
{
"Message": "Date From is greater than Date To"
}
When LastSyncedDate is greater than current date
{
"Message": "Last Synced Date is a Future Date"
}