Day template

Endpoints

Create new day template

/companies/{companycode}/establishments/{establishmentcode}/day-templates

Description

Returns created day template.

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

DayTemplate

Responses

HTTP Code Description Schema

201

Successfully created

DayTemplate

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/day-templates

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

< DayTemplate > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

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

ImportDayTemplateList

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 day template

/companies/{companycode}/establishments/{establishmentcode}/day-templates/{code}

operation.deprecated

Description

Returns retrieved day template.

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

DayTemplate

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete day template

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

DayTemplate

Day template data structure.

Name Description Value Business Rules

code
required

Day template code

string

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

color
optional

Color

string

7 characters max

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

label
required

Day template label

string

50 characters max

periods
optional

Periods

TeamPeriod list

publicUuid
optional
read-only

DayTemplate public uuid

string

style
optional

Style

string

Within (MAINTENANCE=Maintenance, HOLIDAY=Holiday, NOT_WORKED=Not worked)

validityEndDate
optional

Validity end date

datetime

YYYY-MM-DDTHH:MM:SSZ
Set a passed date to make the entity inactive.

TeamPeriod

Name Value Business Rules

beginHour
optional

LocalTime

HH:MM

endHour
optional

LocalTime

HH:MM

productionDay
optional

string

IN(CURRENT,PREVIOUS,NEXT)

teamCode
optional

string

15 characters max

workedPeriod
optional

boolean

LocalTime

Name Value

hour
optional

integer

minute
optional

integer

nano
optional

integer

second
optional

integer

ImportDayTemplateList

Name Value

callback
optional

string

data
optional

DayTemplate list