CRcrunchtime
Projected Consumption Service

getAllProjectedConsumption

Retrieve the details of all projected consumption entries.

get/cruise/projectedconsumption/v1/getAllProjectedConsumption

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/cruise/projectedconsumption/v1/getAllProjectedConsumption
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

locationCodestring required

The Code that identifies the Location in Crunchtime.

projCnsDatestring required

Projected consumption date to retrieve in format DD-MMM-YY.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

Example response

[
  {
    "projectedConsumptionDetailDetails": [
      {
        "productNumber": "R-001",
        "projCnsQty": 99999999.9999
      }
    ],
    "projectedConsumptionHeaderDetails": {
      "locationCode": "000122",
      "projCnsDate": "MM/dd/yyyy"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.