ordercategories

Add a new order category to the database.

POST

/ordercategory

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/ordercategory \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "always_visible": 123,
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": 123,
  "name": "<string>",
  "sort_order": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "data": {
    "ordercategory": {
      "always_visible": 123,
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "sort_order": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "result": "<string>"
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Body

OrderCategory object.

always_visibleinteger

Whether this order category is always visible on the planning board. Returned as 1 (yes) or 0 (no).

codestring

The unique identifier code of this order category.

created_atstring

The date and time this order category was created.

descriptionstring

The description of this order category.

idintegerverplicht

The ID of this order category.

namestring

The name of this order category.

sort_orderinteger

The sort order of this order category.

updated_atstring

The date and time this order category was last updated.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team