POST api/CommodityApi/GetPremiseUsageInformation

Request Information

URI Parameters

None.

Body Parameters

ApiParamOfPremiseUsageInformationCriteriaAndObject

Name	Type	Additional information
AuthKey	AuthenticationKey	Required
Criteria	PremiseUsageInformationCriteria	Required
Data	Object	Required

Request Formats

application/json, text/json

Sample:

{
  "AuthKey": {
    "WebServiceKey": "sample string 1",
    "CompanyID": 1,
    "AppSource": "sample string 2",
    "AppSourceTeam": "sample string 3"
  },
  "Criteria": {
    "CompanyID": 1,
    "RefID": "sample string 1",
    "CustomerID": "sample string 2",
    "CommodityType": "sample string 3",
    "ServiceStart": "2025-05-02T10:59:00.1790449-04:00",
    "ServiceEnd": "2025-05-02T10:59:00.1790449-04:00"
  },
  "Data": {}
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOutputCommonOfListOfPremiseUsageInformation

Name	Type	Additional information
ResponseCode	string	None.
ResponseMessage	string	None.
Data	Collection of PremiseUsageInformation	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "Data": [
    {
      "PremiseID": "sample string 1",
      "CommodityType": "sample string 2",
      "ServiceStart": "2025-05-02T10:59:00.1790449-04:00",
      "ServiceEnd": "2025-05-02T10:59:00.1790449-04:00",
      "Usage": 1.0,
      "Demand": 1.0,
      "MeasurementUnits": "sample string 3",
      "TotalCommodityCharges": 1.0,
      "TotalTaxCharges": 1.0,
      "TotalUtilityCharges": 1.0,
      "AvgTemprature": 1.0,
      "AvgTempratureUOM": "sample string 4",
      "ID": 1,
      "ContractID": "sample string 5",
      "CompanyID": 1,
      "CustomerID": "sample string 6",
      "RefID": "sample string 7",
      "IsActive": true,
      "UpdatedBy": "sample string 8",
      "UpdatedDate": "2025-05-02T10:59:00.1790449-04:00",
      "CreatedBy": "sample string 9",
      "CreatedDate": "2025-05-02T10:59:00.1790449-04:00"
    },
    {
      "PremiseID": "sample string 1",
      "CommodityType": "sample string 2",
      "ServiceStart": "2025-05-02T10:59:00.1790449-04:00",
      "ServiceEnd": "2025-05-02T10:59:00.1790449-04:00",
      "Usage": 1.0,
      "Demand": 1.0,
      "MeasurementUnits": "sample string 3",
      "TotalCommodityCharges": 1.0,
      "TotalTaxCharges": 1.0,
      "TotalUtilityCharges": 1.0,
      "AvgTemprature": 1.0,
      "AvgTempratureUOM": "sample string 4",
      "ID": 1,
      "ContractID": "sample string 5",
      "CompanyID": 1,
      "CustomerID": "sample string 6",
      "RefID": "sample string 7",
      "IsActive": true,
      "UpdatedBy": "sample string 8",
      "UpdatedDate": "2025-05-02T10:59:00.1790449-04:00",
      "CreatedBy": "sample string 9",
      "CreatedDate": "2025-05-02T10:59:00.1790449-04:00"
    }
  ]
}