POST api/CommodityApi/Graph_GetWeeklyUsageData

Request Information

URI Parameters

None.

Body Parameters

ApiParamOfGraphWeeklyUsageDataCriteriaAndObject
NameDescriptionTypeAdditional information
AuthKey

AuthenticationKey

Required

Criteria

GraphWeeklyUsageDataCriteria

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": {
    "ESIID": "sample string 1",
    "CustomerID": "sample string 2",
    "RefID": "sample string 3",
    "StartDate": "2025-05-02T10:44:25.2230738-04:00",
    "EndDate": "2025-05-02T10:44:25.2230738-04:00",
    "Zip": "sample string 4",
    "LanguagePreference": "sample string 5"
  },
  "Data": {}
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOutputCommonOfListOfGraphWeeklyUsageData
NameDescriptionTypeAdditional information
ResponseCode

string

None.

ResponseMessage

string

None.

Data

Collection of GraphWeeklyUsageData

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "Data": [
    {
      "WeeklySeries": "sample string 1",
      "LastWeekUsage": "sample string 2",
      "CurrentWeekUsage": "sample string 3",
      "temperature": "sample string 4",
      "WeekRange": "sample string 5",
      "MinStartDate": "sample string 6"
    },
    {
      "WeeklySeries": "sample string 1",
      "LastWeekUsage": "sample string 2",
      "CurrentWeekUsage": "sample string 3",
      "temperature": "sample string 4",
      "WeekRange": "sample string 5",
      "MinStartDate": "sample string 6"
    }
  ]
}