GET papi/v1/eca/emissiondata?locationCode={locationCode}&year={year}&lastSyncedDate={lastSyncedDate}
Security
Secured API
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationCode | string |
Required |
|
| year | string |
Required |
|
| lastSyncedDate | date |
Required |
Required Headers
| Name | Description | Sample | Type | Default |
|---|---|---|---|---|
| Authorization |
Represents the value of the authentication token. Allow multiple values: no. |
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... | string | None |
| ConsumerId |
Represents the value of the consumer id. Allow multiple values: no. |
2426 | integer | None |
Optional Headers
| Name | Description | Sample | Type | Default |
|---|---|---|---|---|
| ApplicationType |
Represents the value of the consumer's application type. Allow multiple values: no. |
1 | ApplicationType | None |
| Accept-Language |
Represents the value of the desired language for translations. Allow multiple values: yes. |
es | string | en-US |
Body Parameters
None.
Response Information
Resource Description
EmissionDataOutbound| Name | Description | Type | Additional information |
|---|---|---|---|
| Location | string |
None. |
|
| ProgramDetails | Collection of ProgramInfomations |
None. |
Response Formats
application/json, text/json
Sample:
{
"Location": "sample string 1",
"ProgramDetails": [
{
"ProgramId": 1,
"ProgramName": "sample string 2",
"KPIIDetails": [
{
"KPIID": 1,
"KPIName": "sample string 2",
"ScopeType": "sample string 3",
"ActivityType": "sample string 4",
"EnergySourceCatagory": "sample string 5",
"EnergySource": "sample string 6",
"EmissionDetail": [
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
},
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
}
]
},
{
"KPIID": 1,
"KPIName": "sample string 2",
"ScopeType": "sample string 3",
"ActivityType": "sample string 4",
"EnergySourceCatagory": "sample string 5",
"EnergySource": "sample string 6",
"EmissionDetail": [
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
},
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
}
]
}
]
},
{
"ProgramId": 1,
"ProgramName": "sample string 2",
"KPIIDetails": [
{
"KPIID": 1,
"KPIName": "sample string 2",
"ScopeType": "sample string 3",
"ActivityType": "sample string 4",
"EnergySourceCatagory": "sample string 5",
"EnergySource": "sample string 6",
"EmissionDetail": [
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
},
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
}
]
},
{
"KPIID": 1,
"KPIName": "sample string 2",
"ScopeType": "sample string 3",
"ActivityType": "sample string 4",
"EnergySourceCatagory": "sample string 5",
"EnergySource": "sample string 6",
"EmissionDetail": [
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
},
{
"Period": "sample string 1",
"Emission": "sample string 2",
"EmissionData": 3.0,
"EmissionUOM": "sample string 4",
"EmissionType": "sample string 5",
"CreatedBy": "sample string 6",
"CreatedDate": "sample string 7",
"UpdatedBy": "sample string 8",
"Updated Date": "sample string 9"
}
]
}
]
}
]
}
application/xml, text/xml
Sample:
<EmissionDataOutbound xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Location>sample string 1</Location>
<ProgramDetails>
<ProgramInfomations>
<ProgramID>1</ProgramID>
<ProgramName>sample string 2</ProgramName>
<KPIIDetails>
<KPIInformations>
<KPIID>1</KPIID>
<KPIName>sample string 2</KPIName>
<ScopeType>sample string 3</ScopeType>
<ActivityType>sample string 4</ActivityType>
<EnergySourceCatagory>sample string 5</EnergySourceCatagory>
<EnergySource>sample string 6</EnergySource>
<EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
</EmissionDetail>
</KPIInformations>
<KPIInformations>
<KPIID>1</KPIID>
<KPIName>sample string 2</KPIName>
<ScopeType>sample string 3</ScopeType>
<ActivityType>sample string 4</ActivityType>
<EnergySourceCatagory>sample string 5</EnergySourceCatagory>
<EnergySource>sample string 6</EnergySource>
<EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
</EmissionDetail>
</KPIInformations>
</KPIIDetails>
</ProgramInfomations>
<ProgramInfomations>
<ProgramID>1</ProgramID>
<ProgramName>sample string 2</ProgramName>
<KPIIDetails>
<KPIInformations>
<KPIID>1</KPIID>
<KPIName>sample string 2</KPIName>
<ScopeType>sample string 3</ScopeType>
<ActivityType>sample string 4</ActivityType>
<EnergySourceCatagory>sample string 5</EnergySourceCatagory>
<EnergySource>sample string 6</EnergySource>
<EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
</EmissionDetail>
</KPIInformations>
<KPIInformations>
<KPIID>1</KPIID>
<KPIName>sample string 2</KPIName>
<ScopeType>sample string 3</ScopeType>
<ActivityType>sample string 4</ActivityType>
<EnergySourceCatagory>sample string 5</EnergySourceCatagory>
<EnergySource>sample string 6</EnergySource>
<EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
<EmissionDetail>
<Period>sample string 1</Period>
<Emission>sample string 2</Emission>
<EmissionData>3</EmissionData>
<EmissionUOM>sample string 4</EmissionUOM>
<EmissionType>sample string 5</EmissionType>
<CreatedBy>sample string 6</CreatedBy>
<CreatedDate>sample string 7</CreatedDate>
<UpdatedBy>sample string 8</UpdatedBy>
<UpdatedDate>sample string 9</UpdatedDate>
</EmissionDetail>
</EmissionDetail>
</KPIInformations>
</KPIIDetails>
</ProgramInfomations>
</ProgramDetails>
</EmissionDataOutbound>