POST v1/company/driver
WEB - List drivers of the company
Request Information
URI Parameters
None.
Body Parameters
CompanyRequestModelName | Description | Type | Additional information |
---|---|---|---|
only_available_driver |
Set true for only available driver list |
boolean |
None. |
shipment_uid | string |
None. |
|
required_adr | boolean |
None. |
|
is_company_driver | boolean |
None. |
|
is_reliable_driver | boolean |
None. |
|
only_assigned_company_vehicle | boolean |
None. |
|
driver_with_all_assigned_vehicles | boolean |
None. |
|
has_paging | boolean |
None. |
|
page_number | integer |
None. |
|
page_length | integer |
None. |
|
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:
{ "only_available_driver": true, "shipment_uid": "sample string 2", "required_adr": true, "is_company_driver": true, "is_reliable_driver": true, "only_assigned_company_vehicle": true, "driver_with_all_assigned_vehicles": true, "has_paging": true, "page_number": 1, "page_length": 1, "user_company_id": "sample string 5", "user_id": "sample string 6", "user_signature": "sample string 7" }
Response Information
Resource Description
WEB - List drivers of the company
BaseMetaResultModelOfCompanyDriverListResponseModelName | Description | Type | Additional information |
---|---|---|---|
response | CompanyDriverListResponseModel |
None. |
|
meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{ "response": { "company_drivers": [ { "company_driver_id": 1, "company_driver_cellnumber": "sample string 3", "company_driver_fullname": "sample string 4", "company_driver_user_id": "sample string 6", "company_driver_user_inc_id": 7, "company_driver_last_location_lat": 1.1, "company_driver_last_location_long": 1.1, "user_has_offer": true, "is_company_driver": true, "is_reliable_driver": true, "is_approved": 11, "can_offerable": true, "user_is_busy": true, "create_user_uid": "sample string 14", "create_date": "2024-11-25T12:18:22.7675321+03:00", "create_user_name": "sample string 16", "user_assigned_vehicle_licence_plate": "sample string 19", "user_shipment_count": 20, "user_rating": 21, "company_driver_vehicle_id": 22, "company_vehicle_list": [ { "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": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "vehicle_approved": true, "vehicle_is_rental": true, "vehicle_rent_start_date": "2024-11-25T12:18:22.7675321+03:00", "vehicle_rent_end_date": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" }, { "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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" } ], "vehicle_trailer_types": [ 1, 2 ], "vehicle_specs_uid": "sample string 27" }, { "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": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "vehicle_approved": true, "vehicle_is_rental": true, "vehicle_rent_start_date": "2024-11-25T12:18:22.7675321+03:00", "vehicle_rent_end_date": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" }, { "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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" } ], "vehicle_trailer_types": [ 1, 2 ], "vehicle_specs_uid": "sample string 27" } ], "user_vehicle_licence_plate": "sample string 23", "user_last_location_time": "2024-11-25T12:18:22.7675321+03:00" }, { "company_driver_id": 1, "company_driver_cellnumber": "sample string 3", "company_driver_fullname": "sample string 4", "company_driver_user_id": "sample string 6", "company_driver_user_inc_id": 7, "company_driver_last_location_lat": 1.1, "company_driver_last_location_long": 1.1, "user_has_offer": true, "is_company_driver": true, "is_reliable_driver": true, "is_approved": 11, "can_offerable": true, "user_is_busy": true, "create_user_uid": "sample string 14", "create_date": "2024-11-25T12:18:22.7675321+03:00", "create_user_name": "sample string 16", "user_assigned_vehicle_licence_plate": "sample string 19", "user_shipment_count": 20, "user_rating": 21, "company_driver_vehicle_id": 22, "company_vehicle_list": [ { "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": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "vehicle_approved": true, "vehicle_is_rental": true, "vehicle_rent_start_date": "2024-11-25T12:18:22.7675321+03:00", "vehicle_rent_end_date": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" }, { "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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" } ], "vehicle_trailer_types": [ 1, 2 ], "vehicle_specs_uid": "sample string 27" }, { "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": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "vehicle_approved": true, "vehicle_is_rental": true, "vehicle_rent_start_date": "2024-11-25T12:18:22.7675321+03:00", "vehicle_rent_end_date": "2024-11-25T12:18:22.7675321+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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" }, { "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": "2024-11-25T12:18:22.7675321+03:00", "enable_shipment_notifications": true, "user_birthdate": "2024-11-25T12:18:22.7675321+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_param_card_guid": null, "user_is_company_driver": true, "user_invoice_service_guid": "sample string 26", "user_is_test": true, "user_timezone": "sample string 27", "user_cell_country_phone_code": 28, "country_phone_code": 0, "user_iban": "sample string 29", "user_tk_iban": "sample string 30" } ], "vehicle_trailer_types": [ 1, 2 ], "vehicle_specs_uid": "sample string 27" } ], "user_vehicle_licence_plate": "sample string 23", "user_last_location_time": "2024-11-25T12:18:22.7675321+03:00" } ], "total_count": 1 }, "meta": { "status_code": 1, "status_message": "sample string 2" } }