weighttypes

Update an existing weight type.

PUT

/weighttype/{weightTypeId}

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

{
  "data": {
    "result": "<string>",
    "weighttype": {
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "sort_order": 123,
      "specific_density": "<string>",
      "unit_custom_name": "<string>",
      "unit_id": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Padparameters

weightTypeIdstringverplicht

The id of the weight type to perform the action on.

Body

WeightType object.

codestring

The unique identifier code of this weight type, which is generated from the name when left empty.

created_atstring

The date and time this weight type was created.

deleted_atstring

The date and time this weight type was archived, empty when it is not archived.

descriptionstring

The description of this weight type.

idintegerverplicht

The ID of this weight type.

namestringverplicht

The name of this weight type.

sort_orderinteger

The sort order of this weight type.

specific_densitystring

The specific density of this weight type, used to calculate the cubic meters (m³) of a weighing from its weight. Returned as a numeric string, e.g. "12.50".

unit_custom_namestring

The name of the unit of this weight type when no existing unit is selected.

unit_idinteger

The ID of the unit of this weight type, or 0 when a custom unit name is used.

updated_atstring

The date and time this weight type 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