POST V1/GHG.{ext}/CreateReport

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

EMS.GHG.Entities.ReportDefinition
NameDescriptionTypeAdditional information
ReportId

No description available

integer

None.

ReportTitle

No description available

string

None.

PeriodFromMonth

No description available

string

None.

PeriodFromYear

No description available

string

None.

PeriodToMonth

No description available

string

None.

PeriodToYear

No description available

string

None.

BaselineFromMonth

No description available

string

None.

BaselineFromYear

No description available

string

None.

BaselineToMonth

No description available

string

None.

BaselineToYear

No description available

string

None.

Contract

No description available

string

None.

Contractor

No description available

string

None.

Manager

No description available

string

None.

Team

No description available

string

None.

Summary

No description available

string

None.

Description

No description available

string

None.

Commodities

No description available

Collection of EMS.GHG.Entities.Utility

None.

Period

No description available

string

None.

Baseline

No description available

string

None.

Utilites

No description available

string

None.

ReportType

No description available

string

None.

Request Formats

application/json, text/json

Sample:
{
  "reportId": 1,
  "reportTitle": "sample string 1",
  "periodFromMonth": "sample string 2",
  "periodFromYear": "sample string 3",
  "periodToMonth": "sample string 4",
  "periodToYear": "sample string 5",
  "baselineFromMonth": "sample string 6",
  "baselineFromYear": "sample string 7",
  "baselineToMonth": "sample string 8",
  "baselineToYear": "sample string 9",
  "contract": "sample string 10",
  "contractor": "sample string 11",
  "manager": "sample string 12",
  "team": "sample string 13",
  "summary": "sample string 14",
  "description": "sample string 15",
  "commodities": [
    {
      "utilityTypeId": 1,
      "utilityType": "sample string 1",
      "utilityTypeCode": "sample string 2",
      "utilityTypeGroup": "sample string 3"
    },
    {
      "utilityTypeId": 1,
      "utilityType": "sample string 1",
      "utilityTypeCode": "sample string 2",
      "utilityTypeGroup": "sample string 3"
    }
  ],
  "period": "sample string 16",
  "baseline": "sample string 17",
  "utilites": "sample string 18",
  "reportType": "sample string 19"
}

application/xml, text/xml

Sample:
<ReportDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.GHG.Entities">
  <Baseline>sample string 17</Baseline>
  <BaselineFromMonth>sample string 6</BaselineFromMonth>
  <BaselineFromYear>sample string 7</BaselineFromYear>
  <BaselineToMonth>sample string 8</BaselineToMonth>
  <BaselineToYear>sample string 9</BaselineToYear>
  <Commodities>
    <Utility>
      <UtilityType>sample string 1</UtilityType>
      <UtilityTypeCode>sample string 2</UtilityTypeCode>
      <UtilityTypeGroup>sample string 3</UtilityTypeGroup>
      <UtilityTypeId>1</UtilityTypeId>
    </Utility>
    <Utility>
      <UtilityType>sample string 1</UtilityType>
      <UtilityTypeCode>sample string 2</UtilityTypeCode>
      <UtilityTypeGroup>sample string 3</UtilityTypeGroup>
      <UtilityTypeId>1</UtilityTypeId>
    </Utility>
  </Commodities>
  <Contract>sample string 10</Contract>
  <Contractor>sample string 11</Contractor>
  <Description>sample string 15</Description>
  <Manager>sample string 12</Manager>
  <Period>sample string 16</Period>
  <PeriodFromMonth>sample string 2</PeriodFromMonth>
  <PeriodFromYear>sample string 3</PeriodFromYear>
  <PeriodToMonth>sample string 4</PeriodToMonth>
  <PeriodToYear>sample string 5</PeriodToYear>
  <ReportId>1</ReportId>
  <ReportTitle>sample string 1</ReportTitle>
  <ReportType>sample string 19</ReportType>
  <Summary>sample string 14</Summary>
  <Team>sample string 13</Team>
  <Utilites>sample string 18</Utilites>
</ReportDefinition>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Common.TransactionResults
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Common.TransactionResults

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "TransactionResults",
  "response": {
    "transactionResult": [
      {
        "status": "sample string 1",
        "message": "sample string 2",
        "result": "sample string 3"
      },
      {
        "status": "sample string 1",
        "message": "sample string 2",
        "result": "sample string 3"
      }
    ]
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.