Calendar

Endpoints

Create new calendar

/companies/{companycode}/establishments/{establishmentcode}/calendars

Description

Returns created calendar.

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

Calendar

Responses

HTTP Code Description Schema

201

Successfully created

Calendar

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/calendars

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

< Calendar > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/establishments/{establishmentcode}/calendars/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

ImportCalendarList

2 characters max

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 calendar

/companies/{companycode}/establishments/{establishmentcode}/calendars/{code}

operation.deprecated

Description

Returns retrieved calendar.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

Calendar

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete calendar

/companies/{companycode}/establishments/{establishmentcode}/calendars/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

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

Calendar

Description of a calendar.

Name Description Value Business Rules

code
required

Calendar code

string

10 characters max

companyCode
required

Current company code

string

2 characters max

defaultDayTemplateCode
required

Default day template code

string

details
optional

CalendarDetail list

establishmentCode
required

Current establishment code

string

2 characters max

imageCode
optional

string

label
required

Calendar label

string

50 characters max

publicUuid
optional
read-only

Calendar public uuid

string

usedByDefault
optional

boolean

validityEndDate
optional

datetime

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

CalendarDetail

Name Value Business Rules

date
optional

date

AAAA-MM-JJTHH:MM:SSZ

dayTemplateCode
optional

string

10 characters max

ImportCalendarList

Name Value

callback
optional

string

data
optional

Calendar list