CreateInspection

POST /api/inspection

Headers

  • Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

application/json

Body

  • attachments array[object]

    Inspection attachments

    Hide attachments attributes Show attachments attributes object
    • attachment_id integer(int64) Required

      Reference to the identifier of an existing attachment.

    • name string

      Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name

  • inspection_content object Required
  • inspection_type string Required

    Inspection type

    Values are CONDITION, CTPAT, ISSUE, or TIRE.

  • trailer_id integer(int64)

    Reference to the identifier of a created trailer. At least (and at most) one of trailerId or truckId must be given

  • truck_id integer(int64)

    Reference to the identifier of a created truck. At least (and at most) one of trailerId or truckId must be given

  • yard_movement_id integer(int64)

Responses

POST /api/inspection
curl \
 -X POST http://127.0.0.1:8080/api/inspection \
 -H "Content-Type: application/json" \
 -d '{"attachments":[{"attachment_id":42,"name":"string"}],"inspection_content":{},"inspection_type":"CONDITION","trailer_id":42,"truck_id":42,"yard_movement_id":42}'
Request examples
# Headers

# Payload
{
  "attachments": [
    {
      "attachment_id": 42,
      "name": "string"
    }
  ],
  "inspection_content": {},
  "inspection_type": "CONDITION",
  "trailer_id": 42,
  "truck_id": 42,
  "yard_movement_id": 42
}
Response examples (201)
{"attachments"=>[{"attachment_id"=>42, "name"=>"string"}], "created_at"=>"2024-05-04T09:42:00+00:00", "id"=>42, "inspection_content"=>{}, "inspection_type"=>"string", "last_modified_at"=>"2024-05-04T09:42:00+00:00", "trailer_id"=>42, "trailer_number"=>"string", "truck_id"=>42, "truck_number"=>"string", "yard_movement_id"=>42}