Area

Endpoints

Create new area

/companies/{companycode}/establishments/{establishmentcode}/areas

Description

Returns created area.

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

Area

Responses

HTTP Code Description Schema

201

Successfully created

Area

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/areas

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

< Area > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

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

ImportAreaList

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 area

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

operation.deprecated

Description

Returns retrieved area.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Area 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

Area

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete area

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

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Area 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

Area

Area data structure.

Name Description Value Business Rules

code
required

Area code

string

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

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

improvementFields
optional

ImprovementFieldDTO list

label
required

Area label

string

50 characters max

publicUuid
optional
read-only

Area public uuid

string

validityEndDate
optional

datetime

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

ImprovementFieldDTO

Name Value Business Rules

code
optional

string

10 characters max

label
optional

string

50 characters max

usedInWorkshop
optional

boolean

validityBeginAt
optional

datetime

YYYY-MM-DDTHH:MM:SSZ

validityEndAt
optional

datetime

YYYY-MM-DDTHH:MM:SSZ

ImportAreaList

Name Value

callback
optional

string

data
optional

Area list