Data Access Forecast requirements

Endpoints

Get list of forecast requirements.

/processes/{processCode}/data-access/forecast-requirements

Description

Returns forecast requirements (conditional on the Data Access offer).

Parameters

Type Name Description Schema Business rules

Path

processCode
required

Process code to extract from

string

15 characters max

Query

page
optional

Page index

integer (int32)

1 by default

Query

size
optional

Entity count per page

integer (int32)

10 by default

Query

sizeOverride
optional

Overrides size if greater than zero

integer (int32)

0 by default

Responses

HTTP Code Description Schema

200

Successfull

< GetForecastRequirements > array

400

Functionnal error

No Content

403

Not allowed without Data Access offer

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

GetForecastRequirements

Forecast requirements data structure for Get.

Name Description Value Business rules

companyCode
optional

Company code

string

2 characters max

establishmentCode
optional

Establishment code

string

2 characters max

depositCode
optional

Deposit code

string

10 characters max

itemCode
required

Item code

string

20 characters max

startDate
required

Start date

datetime

YYYY-MM-DDTHH:MM:SSZ

endDate
required

End date

datetime

YYYY-MM-DDTHH:MM:SSZ

quantity
required

Requirement quantity

double

The value is in the unit defined below

unitCode
required

Unit code

string

The quantity unit
5 characters max