Vehicle

Download schema

Create

POST

https://dev.hub.radarbov.app

/api/vehicles

Bearer (JWT)

Create › Request Body

Vehicle Create

str_brand

string · required

str_color

string · required

str_fuel

string · required

str_last_registration

string · required

str_license_plate

string · required

str_model

string · required

str_renavam_number

string · required

str_type

string · required

str_year_of_manufacture

string · required

id

string

lt_path

string

owner_id

string

str_trailer_plate

string

Create › Responses

Created

Vehicle · required

POST/api/vehicles

curl https://dev.hub.radarbov.app/api/vehicles \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "id",
  "lt_path": "lt_path",
  "owner_id": "owner_id",
  "str_brand": "str_brand",
  "str_color": "str_color",
  "str_fuel": "str_fuel",
  "str_last_registration": "str_last_registration",
  "str_license_plate": "str_license_plate",
  "str_model": "str_model",
  "str_renavam_number": "str_renavam_number",
  "str_trailer_plate": "str_trailer_plate",
  "str_type": "str_type",
  "str_year_of_manufacture": "str_year_of_manufacture"
}'

Example Request Body

{
  "id": "id",
  "lt_path": "lt_path",
  "owner_id": "owner_id",
  "str_brand": "str_brand",
  "str_color": "str_color",
  "str_fuel": "str_fuel",
  "str_last_registration": "str_last_registration",
  "str_license_plate": "str_license_plate",
  "str_model": "str_model",
  "str_renavam_number": "str_renavam_number",
  "str_trailer_plate": "str_trailer_plate",
  "str_type": "str_type",
  "str_year_of_manufacture": "str_year_of_manufacture"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "owner": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lst_states": [
        "string"
      ],
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_brand": "str_brand",
    "str_color": "str_color",
    "str_fuel": "str_fuel",
    "str_last_registration": "str_last_registration",
    "str_license_plate": "str_license_plate",
    "str_model": "str_model",
    "str_renavam_number": "str_renavam_number",
    "str_trailer_plate": "str_trailer_plate",
    "str_type": "str_type",
    "str_year_of_manufacture": "str_year_of_manufacture",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Show

GET

https://dev.hub.radarbov.app

/api/vehicles/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Vehicle · required

GET/api/vehicles/{id}

curl https://dev.hub.radarbov.app/api/vehicles/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "owner": {
      "bl_active": true,
      "bl_admin": true,
      "bl_cancelled": true,
      "bl_org_admin": true,
      "county": {
        "id": "00000000-0000-0000-0000-000000000000",
        "str_federative_unit": "str_federative_unit",
        "str_ibge_code": "str_ibge_code",
        "str_name": "str_name",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "lst_states": [
        "string"
      ],
      "str_document": "str_document",
      "str_email": "str_email",
      "str_name": "str_name",
      "str_phone": "str_phone",
      "str_status": "str_status",
      "str_type": "str_type",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    },
    "str_brand": "str_brand",
    "str_color": "str_color",
    "str_fuel": "str_fuel",
    "str_last_registration": "str_last_registration",
    "str_license_plate": "str_license_plate",
    "str_model": "str_model",
    "str_renavam_number": "str_renavam_number",
    "str_trailer_plate": "str_trailer_plate",
    "str_type": "str_type",
    "str_year_of_manufacture": "str_year_of_manufacture",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Search

POST

https://dev.hub.radarbov.app

/api/vehicles/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Vehicle[] · required

PaginationMeta · required

POST/api/vehicles/search

curl https://dev.hub.radarbov.app/api/vehicles/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "owner": {
        "bl_active": true,
        "bl_admin": true,
        "bl_cancelled": true,
        "bl_org_admin": true,
        "county": {
          "id": "00000000-0000-0000-0000-000000000000",
          "str_federative_unit": "str_federative_unit",
          "str_ibge_code": "str_ibge_code",
          "str_name": "str_name",
          "ts_created_at": "2024-08-25T15:00:00Z",
          "ts_updated_at": "2024-08-25T15:00:00Z"
        },
        "id": "00000000-0000-0000-0000-000000000000",
        "lst_states": [
          "string"
        ],
        "str_document": "str_document",
        "str_email": "str_email",
        "str_name": "str_name",
        "str_phone": "str_phone",
        "str_status": "str_status",
        "str_type": "str_type",
        "ts_created_at": "2024-08-25T15:00:00Z",
        "ts_updated_at": "2024-08-25T15:00:00Z"
      },
      "str_brand": "str_brand",
      "str_color": "str_color",
      "str_fuel": "str_fuel",
      "str_last_registration": "str_last_registration",
      "str_license_plate": "str_license_plate",
      "str_model": "str_model",
      "str_renavam_number": "str_renavam_number",
      "str_trailer_plate": "str_trailer_plate",
      "str_type": "str_type",
      "str_year_of_manufacture": "str_year_of_manufacture",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

User Verification

Create

POST

https://dev.hub.radarbov.app

/api/vehicles

Bearer (JWT)

Create › Request Body

Vehicle Create

str_brand

string · required

str_color

string · required

str_fuel

string · required

str_last_registration

string · required

str_license_plate

string · required

str_model

string · required

str_renavam_number

string · required

str_type

string · required

str_year_of_manufacture

string · required

id

string

lt_path

string

owner_id

string

str_trailer_plate

string

Create › Responses

Created

Vehicle · required

POST

https://dev.hub.radarbov.app

/api/vehicles/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Vehicle[] · required

PaginationMeta · required