Data Access Forecast plan

Endpoints

Get list of forecast plans

/forecast/companies/{companycode}/establishments/{establishmentcode}/data-access/forecast-plans

Description

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

Parameters

Type Name Description Schema Business rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Query

budget
optional

True if only budget plans, False if only not budget plans ?

boolean

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< ForecastPlan > 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

ForecastPlan

Forecast plan data structure for Get.

Name Description Value Business rules

companyCode
optional

Current company code

string

2 characters max

establishmentCode
optional

Current establishment code

string

2 characters max

planCode
required

Plan code

string

10 characters max

planLabel
optional

Plan label

string

30 characters max

budget
optional

Budget

boolean