Team

Endpoints

Create new team

/companies/{companycode}/establishments/{establishmentcode}/teams

Description

Returns created team.

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

CodeLabelImageValidity

Responses

HTTP Code Description Schema

201

Successfully created

CodeLabelImageValidity

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/teams

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

< CodeLabelImageValidity > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

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

ImportCodeLabelImageValidityList

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 team

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

operation.deprecated

Description

Returns retrieved team.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

15 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

CodeLabelImageValidity

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete team

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

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

15 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

CodeLabelImageValidity

Entity data structure.

Name Description Value Business Rules

code
required

Entity code

string

15 characters max

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

imageCode
optional

string

label
required

Entity label

string

50 characters max

publicUuid
optional
read-only

Entity public uuid

string

validityEndDate
optional

datetime

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

ImportCodeLabelImageValidityList

Name Value

callback
optional

string

data
optional

CodeLabelImageValidity list