POST v1/company/vehicle/list

WEB - List company's vehicles.

Request Information

URI Parameters

None.

Body Parameters

CompanyVehicleRequestModel
NameDescriptionTypeAdditional information
user_company_id

Company UID of the active user

string

Required

Data type: Text

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text

Request Format

application/json, text/json

Sample:
{
  "user_company_id": "sample string 1",
  "user_id": "sample string 2",
  "user_signature": "sample string 3"
}

Response Information

Resource Description

WEB - List company's vehicles.

UserVehicleResultModel
NameDescriptionTypeAdditional information
response

UserVehicleResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "vehicles": [
      {
        "vehicle_id": 1,
        "vehicle_company_id": "sample string 2",
        "vehicle_user_id": "sample string 3",
        "vehicle_type": 4,
        "vehicle_licence_plate": "sample string 5",
        "vehicle_brand": "sample string 6",
        "vehicle_image": "sample string 7",
        "vehicle_reg_image_front": "sample string 8",
        "vehicle_reg_image_back": "sample string 9",
        "vehicle_insurance_image": "sample string 10",
        "vehicle_insurance_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_kbelgesi_image": "sample string 11",
        "vehicle_trailer_type": 12,
        "vehicle_year": 13,
        "vehicle_max_capacity": 14,
        "vehicle_max_tonnage": 15,
        "vehicle_has_adr": true,
        "vehicle_date_time": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_approved": true,
        "vehicle_is_rental": true,
        "vehicle_rent_start_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_rent_end_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_rent_document": "sample string 20",
        "vehicle_enabled": true,
        "vehicle_create_user_uid": "sample string 22",
        "vehicle_identity_number": "sample string 23",
        "vehicle_active_shipment_count": 24,
        "vehicle_driver_name": "sample string 25",
        "vehicle_drivers": [
          {
            "user_id": "sample string 2",
            "user_first_name": "sample string 3",
            "user_cell_number": "sample string 4",
            "user_citizenship_number": "sample string 5",
            "user_image": "sample string 6",
            "user_mailing_address": "sample string 7",
            "user_driving_license_image_front": "sample string 8",
            "user_driving_license_code": "sample string 9",
            "user_driving_license_image_back": "sample string 10",
            "user_src_document_image": "sample string 11",
            "user_psyc_document_image": "sample string 12",
            "user_available": true,
            "user_active": true,
            "user_rating": 1,
            "user_key": "sample string 13",
            "user_secret": "sample string 14",
            "user_type": 15,
            "user_insurance_approved": true,
            "user_create_date": "2019-10-19T12:26:54.796809+03:00",
            "enable_shipment_notifications": true,
            "user_birthdate": "2019-10-19T12:26:54.796809+03:00",
            "user_is_busy": true,
            "user_total_score": 22,
            "user_league_rank": 23,
            "user_league_level": "sample string 24",
            "user_param_card_status": 1,
            "user_is_company_driver": true
          },
          {
            "user_id": "sample string 2",
            "user_first_name": "sample string 3",
            "user_cell_number": "sample string 4",
            "user_citizenship_number": "sample string 5",
            "user_image": "sample string 6",
            "user_mailing_address": "sample string 7",
            "user_driving_license_image_front": "sample string 8",
            "user_driving_license_code": "sample string 9",
            "user_driving_license_image_back": "sample string 10",
            "user_src_document_image": "sample string 11",
            "user_psyc_document_image": "sample string 12",
            "user_available": true,
            "user_active": true,
            "user_rating": 1,
            "user_key": "sample string 13",
            "user_secret": "sample string 14",
            "user_type": 15,
            "user_insurance_approved": true,
            "user_create_date": "2019-10-19T12:26:54.796809+03:00",
            "enable_shipment_notifications": true,
            "user_birthdate": "2019-10-19T12:26:54.796809+03:00",
            "user_is_busy": true,
            "user_total_score": 22,
            "user_league_rank": 23,
            "user_league_level": "sample string 24",
            "user_param_card_status": 1,
            "user_is_company_driver": true
          }
        ],
        "vehicle_trailer_types": [
          1,
          2
        ]
      },
      {
        "vehicle_id": 1,
        "vehicle_company_id": "sample string 2",
        "vehicle_user_id": "sample string 3",
        "vehicle_type": 4,
        "vehicle_licence_plate": "sample string 5",
        "vehicle_brand": "sample string 6",
        "vehicle_image": "sample string 7",
        "vehicle_reg_image_front": "sample string 8",
        "vehicle_reg_image_back": "sample string 9",
        "vehicle_insurance_image": "sample string 10",
        "vehicle_insurance_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_kbelgesi_image": "sample string 11",
        "vehicle_trailer_type": 12,
        "vehicle_year": 13,
        "vehicle_max_capacity": 14,
        "vehicle_max_tonnage": 15,
        "vehicle_has_adr": true,
        "vehicle_date_time": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_approved": true,
        "vehicle_is_rental": true,
        "vehicle_rent_start_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_rent_end_date": "2019-10-19T12:26:54.796809+03:00",
        "vehicle_rent_document": "sample string 20",
        "vehicle_enabled": true,
        "vehicle_create_user_uid": "sample string 22",
        "vehicle_identity_number": "sample string 23",
        "vehicle_active_shipment_count": 24,
        "vehicle_driver_name": "sample string 25",
        "vehicle_drivers": [
          {
            "user_id": "sample string 2",
            "user_first_name": "sample string 3",
            "user_cell_number": "sample string 4",
            "user_citizenship_number": "sample string 5",
            "user_image": "sample string 6",
            "user_mailing_address": "sample string 7",
            "user_driving_license_image_front": "sample string 8",
            "user_driving_license_code": "sample string 9",
            "user_driving_license_image_back": "sample string 10",
            "user_src_document_image": "sample string 11",
            "user_psyc_document_image": "sample string 12",
            "user_available": true,
            "user_active": true,
            "user_rating": 1,
            "user_key": "sample string 13",
            "user_secret": "sample string 14",
            "user_type": 15,
            "user_insurance_approved": true,
            "user_create_date": "2019-10-19T12:26:54.796809+03:00",
            "enable_shipment_notifications": true,
            "user_birthdate": "2019-10-19T12:26:54.796809+03:00",
            "user_is_busy": true,
            "user_total_score": 22,
            "user_league_rank": 23,
            "user_league_level": "sample string 24",
            "user_param_card_status": 1,
            "user_is_company_driver": true
          },
          {
            "user_id": "sample string 2",
            "user_first_name": "sample string 3",
            "user_cell_number": "sample string 4",
            "user_citizenship_number": "sample string 5",
            "user_image": "sample string 6",
            "user_mailing_address": "sample string 7",
            "user_driving_license_image_front": "sample string 8",
            "user_driving_license_code": "sample string 9",
            "user_driving_license_image_back": "sample string 10",
            "user_src_document_image": "sample string 11",
            "user_psyc_document_image": "sample string 12",
            "user_available": true,
            "user_active": true,
            "user_rating": 1,
            "user_key": "sample string 13",
            "user_secret": "sample string 14",
            "user_type": 15,
            "user_insurance_approved": true,
            "user_create_date": "2019-10-19T12:26:54.796809+03:00",
            "enable_shipment_notifications": true,
            "user_birthdate": "2019-10-19T12:26:54.796809+03:00",
            "user_is_busy": true,
            "user_total_score": 22,
            "user_league_rank": 23,
            "user_league_level": "sample string 24",
            "user_param_card_status": 1,
            "user_is_company_driver": true
          }
        ],
        "vehicle_trailer_types": [
          1,
          2
        ]
      }
    ],
    "total_count": 1
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}