create

POST /api/yard

Headers

X-Gatego-oid

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

address string
max_capacity integer(int32)
name string Required
place_id string

Responses

201 */*

Created
Hide response attributes Show response attributes object
- address string
- carriers array[object]
  
  Hide carriers attributes Show carriers attributes object
  
  authorized boolean
  
  capacity integer(int64)
  
  carrier_id integer(int64)
- created_at string(date-time)
- id integer(int64)
- last_modified_at string(date-time)
- max_capacity integer(int32)
- name string
- organization_id integer(int64)
- place_id string
401

Unauthorized
403

Forbidden
404

Not Found

POST /api/yard

curl \
 -X POST http://127.0.0.1:8080/api/yard \
 -H "Content-Type: application/json" \
 -d '{"address":"string","max_capacity":42,"name":"string","place_id":"string"}'

Request examples

# Headers

# Payload
{
  "address": "string",
  "max_capacity": 42,
  "name": "string",
  "place_id": "string"
}

Response examples (201)

{"address"=>"string", "carriers"=>[{"authorized"=>true, "capacity"=>42, "carrier_id"=>42}], "created_at"=>"2024-05-04T09:42:00+00:00", "id"=>42, "last_modified_at"=>"2024-05-04T09:42:00+00:00", "max_capacity"=>42, "name"=>"string", "organization_id"=>42, "place_id"=>"string"}