Create a new load

POST 
/loads

Create a new load.

Request

application/json

Body

required

setName stringrequired
loadType stringrequired
maxWeight numberrequired
loadPositions string[]required
properties object

Responses

201

Load created

application/json

Schema

Schema

_id uuid
name string
setName string
loadType string
maxWeight number
loadPositions string[]
properties object
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "setName": "string",
  "loadType": "string",
  "maxWeight": 0,
  "loadPositions": [
    "string"
  ],
  "properties": {},
  "createdAt": "2025-06-05T13:40:40.614Z",
  "updatedAt": "2025-06-05T13:40:40.614Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "name is required."
    },
    {
      "field": "setName",
      "message": "setName is required."
    },
    {
      "field": "loadType",
      "message": "loadType is required"
    },
    {
      "field": "loadPositions",
      "message": "loadPositions can not be empty"
    },
    {
      "field": "maxWeight",
      "message": "maxWeight is required"
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "name is required."
    },
    {
      "field": "setName",
      "message": "setName is required."
    },
    {
      "field": "loadType",
      "message": "loadType is required"
    },
    {
      "field": "loadPositions",
      "message": "loadPositions can not be empty"
    },
    {
      "field": "maxWeight",
      "message": "maxWeight is required"
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

409

A load with the given details already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A load with the given details already exists."
}

Example

{
  "message": "A load with the given details already exists."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...