POST v1/company/driver/findNearby

WEB - Find drivers near to a location

Request Information

URI Parameters

None.

Body Parameters

CompanyFindDriverRequestModel
NameDescriptionTypeAdditional information
location_lat

Latitude of the location to find nearby drivers

decimal number

Required

location_long

Longitude of the location to find nearby drivers

decimal number

Required

location_distance

Allowed distance tolerance for nearby drivers (in meters)

decimal number

Required

min_allowed_location_time

Minimum allowed location time

date

Required

min_vehicle_capacity

Optional filter for filtering out vehicle capacity in ton's

integer

None.

use_only_company_drivers

Flag to include only defined company drivers

boolean

None.

vehicle_type

string

None.

vehicle_trailer_type

string

None.

shipment_uid

string

None.

required_adr

boolean

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:
{
  "location_lat": 1.1,
  "location_long": 2.1,
  "location_distance": 3.0,
  "min_allowed_location_time": "2018-11-21T09:25:36.1621707+03:00",
  "min_vehicle_capacity": 1,
  "use_only_company_drivers": true,
  "vehicle_type": "sample string 6",
  "vehicle_trailer_type": "sample string 7",
  "shipment_uid": "sample string 8",
  "required_adr": true,
  "user_company_id": "sample string 10",
  "user_id": "sample string 11",
  "user_signature": "sample string 12"
}

Response Information

Resource Description

WEB - Find drivers near to a location

BaseMetaResultModelOfCompanyFindDriverResponseModel
NameDescriptionTypeAdditional information
response

CompanyFindDriverResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "drivers": [
      {
        "user_last_location_lat": 1.1,
        "user_last_location_long": 1.1,
        "user_last_location_time": "2018-11-21T09:25:36.1777947+03:00",
        "user_location_distance": 1.1,
        "is_company_driver": true,
        "user_stats": [
          {
            "ufs_sq_id": 3,
            "ufs_sq_text": "sample string 4",
            "ufs_feedback_count": 1,
            "ufs_yes_answer_count": 1,
            "ufs_point_sum": 1,
            "ufs_average_point": 5.0,
            "ufs_average_yes": 6.0
          },
          {
            "ufs_sq_id": 3,
            "ufs_sq_text": "sample string 4",
            "ufs_feedback_count": 1,
            "ufs_yes_answer_count": 1,
            "ufs_point_sum": 1,
            "ufs_average_point": 5.0,
            "ufs_average_yes": 6.0
          }
        ],
        "user_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_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": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_approved": true,
            "vehicle_is_rental": true,
            "vehicle_rent_start_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_end_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_document": "sample string 20",
            "vehicle_enabled": true
          },
          {
            "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_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": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_approved": true,
            "vehicle_is_rental": true,
            "vehicle_rent_start_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_end_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_document": "sample string 20",
            "vehicle_enabled": true
          }
        ],
        "user_id": 4,
        "user_uid": "sample string 5",
        "user_first_name": "sample string 6",
        "user_cell_number": "sample string 7",
        "user_citizenship_number": "sample string 8",
        "user_image": "sample string 9",
        "user_mailing_address": "sample string 10",
        "user_driving_license_image_front": "sample string 11",
        "user_driving_license_image_back": "sample string 12",
        "user_src_document_image": "sample string 13",
        "user_psyc_document_image": "sample string 14",
        "user_available": true,
        "user_active": true,
        "user_rating": 1,
        "user_type": 15,
        "user_insurance_approved": true,
        "user_create_date": "2018-11-21T09:25:36.1777947+03:00",
        "enable_shipment_notifications": true
      },
      {
        "user_last_location_lat": 1.1,
        "user_last_location_long": 1.1,
        "user_last_location_time": "2018-11-21T09:25:36.1777947+03:00",
        "user_location_distance": 1.1,
        "is_company_driver": true,
        "user_stats": [
          {
            "ufs_sq_id": 3,
            "ufs_sq_text": "sample string 4",
            "ufs_feedback_count": 1,
            "ufs_yes_answer_count": 1,
            "ufs_point_sum": 1,
            "ufs_average_point": 5.0,
            "ufs_average_yes": 6.0
          },
          {
            "ufs_sq_id": 3,
            "ufs_sq_text": "sample string 4",
            "ufs_feedback_count": 1,
            "ufs_yes_answer_count": 1,
            "ufs_point_sum": 1,
            "ufs_average_point": 5.0,
            "ufs_average_yes": 6.0
          }
        ],
        "user_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_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": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_approved": true,
            "vehicle_is_rental": true,
            "vehicle_rent_start_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_end_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_document": "sample string 20",
            "vehicle_enabled": true
          },
          {
            "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_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": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_approved": true,
            "vehicle_is_rental": true,
            "vehicle_rent_start_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_end_date": "2018-11-21T09:25:36.1777947+03:00",
            "vehicle_rent_document": "sample string 20",
            "vehicle_enabled": true
          }
        ],
        "user_id": 4,
        "user_uid": "sample string 5",
        "user_first_name": "sample string 6",
        "user_cell_number": "sample string 7",
        "user_citizenship_number": "sample string 8",
        "user_image": "sample string 9",
        "user_mailing_address": "sample string 10",
        "user_driving_license_image_front": "sample string 11",
        "user_driving_license_image_back": "sample string 12",
        "user_src_document_image": "sample string 13",
        "user_psyc_document_image": "sample string 14",
        "user_available": true,
        "user_active": true,
        "user_rating": 1,
        "user_type": 15,
        "user_insurance_approved": true,
        "user_create_date": "2018-11-21T09:25:36.1777947+03:00",
        "enable_shipment_notifications": true
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}