Activity family

Endpoints

Create new activity-family

/companies/{companycode}/establishments/{establishmentcode}/activity-families

Description

Returns created activity-family.

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

CodeLabelValidity

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}/activity-families

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

< CodeLabelValidity > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

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

ActivityFamilyRestImpl

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 activity-family

/companies/{companycode}/establishments/{establishmentcode}/activity-families/{code}

operation.deprecated

Description

Returns retrieved activity-family.

Parameters

Type Name Description Schema Business Rules

Path

code
required

ActivityFamily 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

CodeLabelValidity

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete activifamilyext

/companies/{companycode}/establishments/{establishmentcode}/activity-families/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

ActivityFamily public uuid code to delete

string

10 characters max

Path

companyCode
required

Current context company 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

ActivityFamilyRestImpl

Type : object