Skip to content

Vehicle Assignments — Proposed Guide

Planned API — Reference Only

Vehicle Assignments: Assignments would relate a company vehicle to an employee over an effective period. They should retain history rather than overwrite…

Overview

Assignments would relate a company vehicle to an employee over an effective period. They should retain history rather than overwrite a single current driver field.

Key concepts

Check overlapping assignments and organization membership. Keep assignment times distinct from data-entry timestamps.

Implementation considerations

Do not infer permission to incur every vehicle cost from an assignment. Mileage and expense policy requirements remain separate.

Proposed API behavior

POST /v1/fleet/vehicle-assignments is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Illustrative request fields
NameTypeDescription
vehicle_idstringStable fictional vehicle reference; not a secret and not evidence that a resource exists.
user_idstringStable fictional user reference; not a secret and not evidence that a resource exists.
start_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
end_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X POST 'https://api.remizen.example/v1/fleet/vehicle-assignments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "vehicle_id": "veh_example_123",
  "user_id": "usr_example_123",
  "start_date": "2026-01-15",
  "end_date": "2026-01-31"
}'

Fictional response example

201 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "data": {
    "vehicle_id": "veh_example_123",
    "id": "fleet_example_123",
    "organization_id": "org_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Do not infer permission to incur every vehicle cost from an assignment. Mileage and expense policy requirements remain separate.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "error": {
    "code": "validation_error",
    "message": "The proposed vehicle assignments operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
vehicle_idstringStable fictional vehicle reference; not a secret and not evidence that a resource exists.
user_idstringStable fictional user reference; not a secret and not evidence that a resource exists.
start_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.
end_datestring (date)Synthetic calendar date in YYYY-MM-DD form; period inclusivity must be defined by the future contract.