Driver Assignment Service - API Contract

GET /api/v1/driver-assignments/api/v1/driver-assignments

List all driver assignments with optional filtering by contact or coordinator

Public

Response Example

{
  "data": [
    {
      "assignment_id": "asgn_01HX7Z2NQK",
      "contact_id": "cnt_7821",
      "coordinator_id": "usr_coord_004",
      "fee_amount": 350,
      "currency": "NOK",
      "date": "2026-03-20",
      "status": "active",
      "created_at": "2026-03-20T08:14:00Z",
      "updated_at": "2026-03-20T08:14:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 47
  }
}

GET /api/v1/driver-assignments/api/v1/driver-assignments/:assignment_id

Get a single driver assignment by ID

Public

Response Example

{
  "assignment_id": "asgn_01HX7Z2NQK",
  "contact_id": "cnt_7821",
  "coordinator_id": "usr_coord_004",
  "fee_amount": 350,
  "currency": "NOK",
  "date": "2026-03-20",
  "status": "active",
  "declaration_ids": [
    "decl_88A1",
    "decl_88A2"
  ],
  "created_at": "2026-03-20T08:14:00Z",
  "updated_at": "2026-03-20T08:14:00Z"
}

POST /api/v1/driver-assignments/api/v1/driver-assignments

Create a new driver assignment

Public

Request Example

{
  "contact_id": "cnt_7821",
  "coordinator_id": "usr_coord_004",
  "fee_amount": 350,
  "currency": "NOK",
  "date": "2026-03-20"
}

Response Example

{
  "assignment_id": "asgn_01HX7Z2NQK",
  "contact_id": "cnt_7821",
  "coordinator_id": "usr_coord_004",
  "fee_amount": 350,
  "currency": "NOK",
  "date": "2026-03-20",
  "status": "active",
  "created_at": "2026-03-26T09:00:00Z",
  "updated_at": "2026-03-26T09:00:00Z"
}

PUT /api/v1/driver-assignments/api/v1/driver-assignments/:assignment_id

Update an existing driver assignment

Public

Request Example

{
  "fee_amount": 400,
  "date": "2026-03-25",
  "status": "active"
}

Response Example

{
  "assignment_id": "asgn_01HX7Z2NQK",
  "contact_id": "cnt_7821",
  "coordinator_id": "usr_coord_004",
  "fee_amount": 400,
  "currency": "NOK",
  "date": "2026-03-25",
  "status": "active",
  "updated_at": "2026-03-26T10:30:00Z"
}

DELETE /api/v1/driver-assignments/api/v1/driver-assignments/:assignment_id

Soft-delete a driver assignment

Public

Response Example

{
  "assignment_id": "asgn_01HX7Z2NQK",
  "status": "deleted",
  "deleted_at": "2026-03-26T11:00:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}