Operator

Endpoints

Create new operator

/companies/{companycode}/establishments/{establishmentcode}/operators

Description

Returns created operator.

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

OperatorDTO

Responses

HTTP Code Description Schema

201

Successfully created

OperatorDTO

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/establishments/{establishmentcode}/operators

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

< OperatorDTO > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

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

ImportOperatorList

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 operator

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

operation.deprecated

Description

Returns retrieved operator.

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

OperatorDTO

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete operator

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

OperatorDTO

Name Description Value Business Rules

badge
optional

Operator badge code

string

code
required

Operator login code

string

15 characters max

companyCode
required

Current company code

string

2 characters max

establishmentCode
required

Current establishment code

string

2 characters max

family
required

Operator family code

string

10 characters max

firstName
required

Operator first name

string

50 characters max

function
optional

string

imageCode
optional

string

language
optional

string

5 characters max

lastName
required

Operator last name

string

50 characters max

password
optional

string

publicUuid
optional
read-only

Operator public uuid

string

rightHanded
required

Indicate whether operator is right-handed

boolean

tags
optional

TagLink list

validityEndDate
optional

datetime

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

ImportOperatorList

Name Value

callback
optional

string

data
optional

OperatorDTO list

TagLink

Name Value Business Rules

code
optional

string

15 characters max

establishmentCode
optional

string

2 characters max

label
optional

string

50 characters max