---
title: "getProjectedConsumptionByPage"
method: GET
path: "/cruise/projectedconsumption/v1/getProjectedConsumptionByPage"
tags: ["Projected Consumption Service"]
---

# getProjectedConsumptionByPage

`GET /cruise/projectedconsumption/v1/getProjectedConsumptionByPage`

## 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/getProjectedConsumptionByPage`
- Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid`

Retrieve a projected consumption entry's details by page number.

## Query parameters

- `locationCode` string, required
- `pageNumber` integer
- `projCnsDate` string, required
- `pageSize` integer
- `includeNull` boolean

## Headers

- `authenticationtoken` string, required
- `password` string, required
- `sitename` string, required
- `userid` string, required
- `X-B3-TraceId` string

## Response `200`

Success

- ProjectedConsumptionBatchResponseDto: ProjectedConsumptionBatchResponseDto description
  - `hasNext` boolean
  - `projectedConsumptionDetails` ProjectedConsumptionDetails[]
    - `projectedConsumptionDetailDetails` ProjectedConsumptionDetailsDto[]
      - `productNumber` string, required: "productNumber" from projected consumption
      - `projCnsQty` number, required: "projCnsQty" from projected consumption
    - `projectedConsumptionHeaderDetails` ProjectedConsumptionHeaderDto: ProjectedConsumptionHeaderDto description
      - `locationCode` string, required: "locationCode" from projected consumption
      - `projCnsDate` string, required: "projCnsDate" from projected consumption
  - `totalPages` integer

## Other responses

- `400`: Validation Error
- `401`: Authorization
- `404`: projected consumption not found
- `429`: Too Many Requests
- `500`: Unexpected Error
- `503`: System under maintenance
- `504`: Timeout

---

[API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)