Travel

Download schema

Create

POST

https://dev.hub.radarbov.app

/api/v1/travels

Bearer (JWT)

Create › Request Body

Travel Create

id

string · uuid · required

transporter_id

string · required

vehicle_id

string · uuid · required

Travel Embark[]

owner_id

string

Travel Stop[]

str_establishment_code_destination

string

str_establishment_document_destination

string

str_establishment_name_destination

string

ts_end_time

string

Create › Responses

Created

Travel · required

POST/api/v1/travels

curl https://dev.hub.radarbov.app/api/v1/travels \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "embarks": [
    {
      "gta": {
        "str_code": "str_code",
        "str_establishment_code_origin": "str_establishment_code_origin",
        "str_establishment_name_origin": "str_establishment_name_origin",
        "str_federative_unit": "str_federative_unit",
        "str_purpose": "str_purpose",
        "str_series": "str_series"
      },
      "gta_id": "gta_id",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_status": "str_status",
      "ts_arrival_time": "ts_arrival_time",
      "ts_created_at": "ts_created_at",
      "ts_departure_time": "ts_departure_time"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "owner_id": "owner_id",
  "stops": [
    {
      "geo_event_coordinates": "geo_event_coordinates",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_notes": "str_notes",
      "str_title": "str_title",
      "ts_created_at": "ts_created_at",
      "ts_time": "ts_time"
    }
  ],
  "str_establishment_code_destination": "str_establishment_code_destination",
  "str_establishment_document_destination": "str_establishment_document_destination",
  "str_establishment_name_destination": "str_establishment_name_destination",
  "transporter_id": "transporter_id",
  "ts_end_time": "ts_end_time",
  "vehicle_id": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "embarks": [
    {
      "gta": {
        "str_code": "str_code",
        "str_establishment_code_origin": "str_establishment_code_origin",
        "str_establishment_name_origin": "str_establishment_name_origin",
        "str_federative_unit": "str_federative_unit",
        "str_purpose": "str_purpose",
        "str_series": "str_series"
      },
      "gta_id": "gta_id",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_status": "str_status",
      "ts_arrival_time": "ts_arrival_time",
      "ts_created_at": "ts_created_at",
      "ts_departure_time": "ts_departure_time"
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "owner_id": "owner_id",
  "stops": [
    {
      "geo_event_coordinates": "geo_event_coordinates",
      "id": "00000000-0000-0000-0000-000000000000",
      "str_notes": "str_notes",
      "str_title": "str_title",
      "ts_created_at": "ts_created_at",
      "ts_time": "ts_time"
    }
  ],
  "str_establishment_code_destination": "str_establishment_code_destination",
  "str_establishment_document_destination": "str_establishment_document_destination",
  "str_establishment_name_destination": "str_establishment_name_destination",
  "transporter_id": "transporter_id",
  "ts_end_time": "ts_end_time",
  "vehicle_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "embarks": {},
    "geo_coordinates_from": {
      "coordinates": [
        0
      ],
      "type": "Point"
    },
    "geo_coordinates_to": {
      "coordinates": [
        0
      ],
      "type": "Point"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "int_duration": 0,
    "stops": {},
    "str_consignee_name": "str_consignee_name",
    "str_from_control_unit_code": "str_from_control_unit_code",
    "str_from_control_unit_name": "str_from_control_unit_name",
    "str_status": "str_status",
    "str_to_control_unit_code": "str_to_control_unit_code",
    "str_to_control_unit_name": "str_to_control_unit_name",
    "transporter": {
      "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",
      "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"
    },
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_end_time": "2024-08-25T15:00:00Z",
    "ts_start_time": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "vehicle": {
      "id": "00000000-0000-0000-0000-000000000000",
      "owner": {
        "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",
        "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

Tracking

GET

https://dev.hub.radarbov.app

/api/v1/travels/{id}/tracking

Bearer (JWT)

Tracking › path Parameters

id

string · required

Tracking › Responses

Show

GET

https://dev.hub.radarbov.app

/api/v1/travels/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Travel · required

GET/api/v1/travels/{id}

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

Example Responses

{
  "data": {
    "embarks": {},
    "geo_coordinates_from": {
      "coordinates": [
        0
      ],
      "type": "Point"
    },
    "geo_coordinates_to": {
      "coordinates": [
        0
      ],
      "type": "Point"
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "int_duration": 0,
    "stops": {},
    "str_consignee_name": "str_consignee_name",
    "str_from_control_unit_code": "str_from_control_unit_code",
    "str_from_control_unit_name": "str_from_control_unit_name",
    "str_status": "str_status",
    "str_to_control_unit_code": "str_to_control_unit_code",
    "str_to_control_unit_name": "str_to_control_unit_name",
    "transporter": {
      "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",
      "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"
    },
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_end_time": "2024-08-25T15:00:00Z",
    "ts_start_time": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "vehicle": {
      "id": "00000000-0000-0000-0000-000000000000",
      "owner": {
        "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",
        "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/v1/travels/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Travel[] · required

PaginationMeta · required

POST/api/v1/travels/search

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

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "embarks": {},
      "geo_coordinates_from": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "geo_coordinates_to": {
        "coordinates": [
          0
        ],
        "type": "Point"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "int_duration": 0,
      "stops": {},
      "str_consignee_name": "str_consignee_name",
      "str_from_control_unit_code": "str_from_control_unit_code",
      "str_from_control_unit_name": "str_from_control_unit_name",
      "str_status": "str_status",
      "str_to_control_unit_code": "str_to_control_unit_code",
      "str_to_control_unit_name": "str_to_control_unit_name",
      "transporter": {
        "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",
        "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"
      },
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_end_time": "2024-08-25T15:00:00Z",
      "ts_start_time": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z",
      "vehicle": {
        "id": "00000000-0000-0000-0000-000000000000",
        "owner": {
          "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",
          "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

Tags Writeoff User

Create

POST

https://dev.hub.radarbov.app

/api/v1/travels

Bearer (JWT)

Create › Request Body

Travel Create

id

string · uuid · required

transporter_id

string · required

vehicle_id

string · uuid · required

Travel Embark[]

owner_id

string

Travel Stop[]

str_establishment_code_destination

string

str_establishment_document_destination

string

str_establishment_name_destination

string

ts_end_time

string

Create › Responses

Created

Travel · required

POST

https://dev.hub.radarbov.app

/api/v1/travels/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Travel[] · required

PaginationMeta · required