Special day

Endpoints

Create new special day

/companies/{companycode}/establishments/{establishmentcode}/special-days

Description

Returns created special day.

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

Body

body
required

Special day

Responses

HTTP Code Description Schema

201

Successfully created

Special day

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/special-days

Description

Returns entities.

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

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Special day > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/special-days/import

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

Body

body
required

ImportSpecialDayList

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

Get one special day

/companies/{companycode}/establishments/{establishmentcode}/special-days/{date}

Description

Returns retrieved special day.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

date
required

Special day date to retrieve

string (date)

AAAA-MM-JJTHH:MM:SSZ

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

Special day

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete special day

/companies/{companycode}/establishments/{establishmentcode}/special-days/{date}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

date
required

Special day date to delete

string (date)

AAAA-MM-JJTHH:MM:SSZ

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Special day

Special day data structure.

Name Description Value Business Rules

companyCode
required

Current company code

string

2 characters max

date
required

Date

String (ISO-8601)

AAAA-MM-JJTHH:MM:SSZ

dayTemplateCode
required

Day template code

string

10 characters max

establishmentCode
required

Current establishment code

string

2 characters max

publicUuid
optional
read-only

Special day public uuid

string

validityEndDate
optional

Validity end date

datetime

AAAA-MM-JJTHH:MM:SSZ
Set a passed date to make the entity inactive.

ImportSpecialDayList

Name Value

callback
optional

string

data
optional

Special day list