GET
/
lucca-api
/
occupation-categories
/
{id}
Retrieve an occupation-category
curl --request GET \
  --url https://{host}/lucca-api/occupation-categories/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'
{
  "id": "45",
  "type": "occupation-category",
  "url": "https://example.ilucca.net/lucca-api/occupation-categories/45",
  "title": "Executive",
  "businessEstablishments": [
    {
      "id": "5",
      "type": "business-establishment",
      "url": "https://example.ilucca.net/lucca-api/business-establishments/5"
    }
  ],
  "t9n": {
    "title": {
      "fr": "Cadre"
    }
  },
  "links": null
}

Authorizations

​
Authorization
string
header
required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

​
Api-Version
enum<string>
required

Set the API version.

Available options:
2024-11-01
Examples:

"2024-11-01"

​
If-None-Match
string

Only execute the request if current cached version of the resource does not match the one given here.

Examples:

"W/q5sd4w2x1c1gfdg"

​
If-Match
string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Examples:

"W/q5sd4w2x1c1gfdg"

​
Accept-Encoding
string

List of compression algorithms you support.

Path Parameters

​
id
string
required

Identifier of the occupation-category

Minimum length: 1

Query Parameters

​
include
enum<string>[]

Include metadata:

  • embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
  • links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
  • totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Response

200
application/json

OK

The occupation-category resource represents a categorization of employees belonging to a set of business-establishments.

These categories can be used as a way of distinguishing employees in reports, or may be used to specify reserved business rules (e.g. in the leaves management system).

In France, can be used to represent the "Profession et Catégories Professionnelles" (P.C.S.). Embedded resources on a occupation-category(ies) response. An occupation-category resource.