Event

Endpoints

Import entity list

/forecast/companies/{companycode}/establishments/{establishmentcode}/events/import

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Body

body
required

ImportEventList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

ImportEventList

Name Value

callback
optional

string

data
optional

Event list

parameters
optional

EventParameters

Event

Event data structure.

Name Description Value Business rules

startDate
required

Start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

endDate
required

End date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

itemGroupCode
optional

Item group code

string

10 characters max

itemGroupLevel
optional

Item group level

integer

itemGroupValueCode
optional

Item group value code

string

20 characters max

itemCode
optional

Item code

string

20 characters max

customerGroupCode
optional

Customer group code

string

10 characters max

customerGroupLevel
optional

Customer group level

integer

customerGroupValueCode
optional

Customer group value code

string

20 characters max

customerCode
optional

Customer code

string

10 characters max

value
required

Value

double

valueType
required

Value type

string

Within (QTY, MUL, PER) :

QTY = Quantity
MUL = Multiplier coefficient
PER = Percent

unitCode
required if valueType = QTY

Unit code

string

5 characters max

pollutionType
optional

Pollution type

string

Within (DIV, PRM, SPR, HOL, WEA) :

DIV = Miscellaneous event
PRM = Promotion
SPR = Suggested promotion
HOL = Holiday
WEA = Weather effect

comment
optional

Comment

string

1000 characters max

Rules

  • No item selection is not authorized.

  • Item code and item group code/level/value code are not authorized both.

  • No customer selection is authorized only if MUL ou PER value type.

  • Customer code and customer group code/level/value code are not authorized both.

EventParameters

Event parameters structure.

Name Description Value

forecastPlans
optional

Forecast plans

list of string

replaceUpdatedEvents
optional

Replace the updated events (imported events that were later modified by a user) ?

boolean