POST v1/company/driver/assignShipment

WEB - Assign a company shipment to a company driver

Request Information

URI Parameters

None.

Body Parameters

AssignShipmentToDriverRequestModel
NameDescriptionTypeAdditional information
shipment_id

GUID of an existing shipment of the company

string

Required

driver_user_id

GUID of the existing mobile user of the driver

string

Required

driver_vehicle_id

integer

Required

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:
{
  "shipment_id": "sample string 1",
  "driver_user_id": "sample string 2",
  "driver_vehicle_id": 3,
  "user_company_id": "sample string 4",
  "user_id": "sample string 5",
  "user_signature": "sample string 6"
}

Response Information

Resource Description

WEB - Assign a company shipment to a company driver

BaseMetaResultModelOfAssignShipmentToDriverResponseModel
NameDescriptionTypeAdditional information
response

AssignShipmentToDriverResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "offer_created": {
      "offer_id": 1,
      "offer_company_id": "sample string 2",
      "offer_user_id": "sample string 3",
      "offer_shipment_id": "sample string 4",
      "offer_vehicle_id": 5,
      "offer_bank_id": 6,
      "offer_amount": 1,
      "offer_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_company": true,
      "offer_confirmation_company_user": "sample string 8",
      "offer_confirmation_company_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_user": true,
      "offer_confirmation_user_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_payment": true,
      "offer_confirmation_payment_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_departure": true,
      "offer_confirmation_departure_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_user_delivery": true,
      "offer_confirmation_user_delivery_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_confirmation_company_delivery": true,
      "offer_confirmation_company_delivery_date_time": "2018-05-21T13:42:59.8823483+03:00",
      "offer_company_payment_id": 14,
      "offer_user_payment_id": 15,
      "offer_user_declined": true
    }
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}