GET papi/v1/eca/kpidata?locationCode={locationCode}&year={year}&lastSyncedDate={lastSyncedDate}

Security

Secured API

Request Information

URI Parameters

Name	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

KPIOutboundDetails

Name	Description	Type	Additional information
Location		string	None.
ProgramInfo		Collection of ProgramInfomation	None.

Response Formats

application/json, text/json

Sample:

{
  "Location": "sample string 1",
  "ProgramInfo": [
    {
      "ProgramId": 1,
      "ProgramName": "sample string 2",
      "KPIInfo": [
        {
          "KPIID": 1,
          "KPIName": "sample string 2",
          "ReportedValues": [
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            },
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            }
          ]
        },
        {
          "KPIID": 1,
          "KPIName": "sample string 2",
          "ReportedValues": [
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            },
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            }
          ]
        }
      ]
    },
    {
      "ProgramId": 1,
      "ProgramName": "sample string 2",
      "KPIInfo": [
        {
          "KPIID": 1,
          "KPIName": "sample string 2",
          "ReportedValues": [
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            },
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            }
          ]
        },
        {
          "KPIID": 1,
          "KPIName": "sample string 2",
          "ReportedValues": [
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            },
            {
              "Period": "sample string 1",
              "SectionName": "sample string 2",
              "ReportedValue": 3.0,
              "SiteUOM": "sample string 4",
              "ConversionFactor": 5.0,
              "CorporateData": 6.0,
              "CorporateUOM": "sample string 7",
              "MethodOfMeasure": "sample string 8",
              "Created By": "sample string 9",
              "Created Date": "2025-02-11T23:47:40.762Z",
              "Updated By": "sample string 11",
              "Updated Date": "2025-02-11T23:47:40.762Z"
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<KPIOutboundDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Location>sample string 1</Location>
  <ProgramInfo>
    <ProgramInfomation>
      <ProgramID>1</ProgramID>
      <ProgramName>sample string 2</ProgramName>
      <KPIInfo>
        <KPIInformation>
          <KPIID>1</KPIID>
          <KPIName>sample string 2</KPIName>
          <ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
          </ReportedValues>
        </KPIInformation>
        <KPIInformation>
          <KPIID>1</KPIID>
          <KPIName>sample string 2</KPIName>
          <ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
          </ReportedValues>
        </KPIInformation>
      </KPIInfo>
    </ProgramInfomation>
    <ProgramInfomation>
      <ProgramID>1</ProgramID>
      <ProgramName>sample string 2</ProgramName>
      <KPIInfo>
        <KPIInformation>
          <KPIID>1</KPIID>
          <KPIName>sample string 2</KPIName>
          <ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
          </ReportedValues>
        </KPIInformation>
        <KPIInformation>
          <KPIID>1</KPIID>
          <KPIName>sample string 2</KPIName>
          <ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
            <ReportedValues>
              <Period>sample string 1</Period>
              <SectionName>sample string 2</SectionName>
              <ReportedValue>3</ReportedValue>
              <SiteUOM>sample string 4</SiteUOM>
              <ConversionFactor>5</ConversionFactor>
              <CorporateData>6</CorporateData>
              <CorporateUOM>sample string 7</CorporateUOM>
              <MethodOfMeasure>sample string 8</MethodOfMeasure>
              <CreatedBy>sample string 9</CreatedBy>
              <CreatedDate>2025-02-11T18:47:40.7623683-05:00</CreatedDate>
              <UpdatedBy>sample string 11</UpdatedBy>
              <UpdatedDate>2025-02-11T18:47:40.7623683-05:00</UpdatedDate>
            </ReportedValues>
          </ReportedValues>
        </KPIInformation>
      </KPIInfo>
    </ProgramInfomation>
  </ProgramInfo>
</KPIOutboundDetails>