Table of Contents
Background and strategic fit
The purpose of this Integration is to pull over KPI Emission data to support our growing customer base to analyze the Emission data they are entering through the ProcessMAP solution.
...
- KPIs classified as Energy will be pulled
- ProcessMAP assumes anyone who is accessing the Outbound API has required authority to access the data this API contains
- 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 1 year duration at a time to avoid any performance issues
- Data will be shown in Readable JSON format
- Field Names in the Response would be Customer Field Naming
- 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
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.
Example:
Response
BASE URL + Endpoint FOR RESPECTIVE API CALLS
Endpoint : GET papi/v1/eca/emissiondata?locationCode={locationCode}&year={Year}
...
URI Parameters
- Location Code, Year and LastSyncedDate are to be passed as parameters
- Location Code and Year are required parameter but LastSyncedDate is optional
- When both Year and LastSyncedDate are provided, data returned will be any record created/updated since LastSyncedDate for the Year
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationCode | Represents the unique code of location for which KPI Data should be returned | string | Required |
| Year | Represents the year for which the Emission data should be pulled | int | Required |
| LastSyncedDate | Represents the date when API was last called | date | Optional |
Sample Parameters
...
| View file | ||||
|---|---|---|---|---|
|
Field List
...
Emission Data Outbound Field List
| Section | Field Name | Database Column Size |
|---|---|---|
| Location | NVARCHAR(200) | |
| Program Details | ||
| Program Id | INT | |
| Program Name | NVARCHAR(50) | |
| KPI Details | ||
| KPI ID | INT | |
| KPI Name | NVARCHAR(250) | |
| Scope Type | NVARCHAR(100) | |
| Activity Type | NVARCHAR(100) | |
| Energy Source Catagory | NVARCHAR(100) | |
| Energy Source | NVARCHAR(100) | |
| Emission Detail | ||
| Period | NVARCHAR(50) | |
| Emission | NVARCHAR(50) | |
| Emission Data | DECIMAL(32,10) | |
| Emission UOM | NVARCHAR(50) | |
| Emission Type | NVARCHAR(20) | |
| Created By | NVARCHAR(200) | |
| Created Date | NVARCHAR(30) | |
| Updated By | NVARCHAR(200) | |
| Updated Date | NVARCHAR(30) |
Errors/Validation Messages
...