KPI Emission Factor Outbound API

Background and strategic fit

The purpose of this Integration is to pull over KPI Emission Factor to support our growing customer base to analyze the Emission Factor they are configuring through the ProcessMAP solution.

Assumption

Only 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 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:

Environment	Base URL	Method
UAT	https://integrationsvc.uat.pmapconnect.com/outbound/papi/v1/eca/emissionfactor?locationCode={locationCode}&year={year}&lastSyncedDate={lastSyncedDate}	GET
Production	https://integrationsvc.processmap.com/outbound/papi/v1/eca/emissionfactor?locationCode={locationCode}&year={year}&lastSyncedDate={lastSyncedDate}	GET

Endpoint : GET papi/v1/eca/emissionfactor?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 Factor should be pulled	int	Required
LastSyncedDate	Represents the date when API was last called	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

Emission Factor Outbound Field List

Section	Field Name	Database Column Size
	Location	NVARCHAR(200)
Program Detail
	Program Id	INT
	Program Name	NVARCHAR(50)
KPI Detail
	KPI ID	INT
	KPI Name	NVARCHAR(250)
Emission Details
	Emission	NVARCHAR(50)
	Start Date	DATETIME
	End Date	DATETIME
	Emission Type	NVARCHAR(25)
	Emission Factor From UOM	NVARCHAR(50)
	Emission Factor To UOM	NVARCHAR(50)
	Emission Factor	DECIMAL(32,10)
	GWP	DECIMAL(32,10)
	Heat Value Factor	DECIMAL(32,10)
	Heat Value From UOM	NVARCHAR(50)
	Heat Value To UOM	NVARCHAR(50)
	Emission Basis UOM	NVARCHAR(50)
	Emission Basis Conversion Factor	DECIMAL(32,10)
	Emission Basis Conversion Factor From UOM	NVARCHAR(50)
	Emission Basis Conversion Factor To UOM	NVARCHAR(50)
	Notes	NVARCHAR(4000)
	Reference	NVARCHAR(2000)
	Created By	NVARCHAR(200)
	Created Date	NVARCHAR(30)
	Updated By	NVARCHAR(200)
	Updated Date	NVARCHAR(30)

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"
}