POST v1/company/shipment/location

WEB - User location in transit.

Request Information

URI Parameters

None.

Body Parameters

ShipmentLocationRequestModel
NameDescriptionTypeAdditional information
shipment_company_id

string

Required
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_company_id": "sample string 1",
  "user_id": "sample string 2",
  "user_signature": "sample string 3"
}

Response Information

Resource Description

WEB - User location in transit.

ShipmentLocationResultModel
NameDescriptionTypeAdditional information
response

ShipmentLocationResponse

None.
meta

Basic meta information for the operation result

 MetaModel

None.

Response Format

application/json, text/json

Sample: 
{
  "response": {
    "last_known_locations": [
      {
        "shipment": {
          "shipment_id": "sample string 1"
        },
        "user": {
          "user_first_name": "sample string 1",
          "user_image": "sample string 2",
          "user_rating": 3
        },
        "location": {
          "latitude": "sample string 1",
          "longitude": "sample string 2",
          "last_location_time": "2024-11-25T22:31:38.0605009+03:00"
        },
        "vehicle": {
          "vehicle_type": 1,
          "vehicle_licence_plate": "sample string 2",
          "vehicle_brand": "sample string 3",
          "vehicle_image": "sample string 4",
          "vehicle_year": 5,
          "vehicle_max_capacity": 6,
          "vehicle_approved": true
        }
      },
      {
        "shipment": {
          "shipment_id": "sample string 1"
        },
        "user": {
          "user_first_name": "sample string 1",
          "user_image": "sample string 2",
          "user_rating": 3
        },
        "location": {
          "latitude": "sample string 1",
          "longitude": "sample string 2",
          "last_location_time": "2024-11-25T22:31:38.0605009+03:00"
        },
        "vehicle": {
          "vehicle_type": 1,
          "vehicle_licence_plate": "sample string 2",
          "vehicle_brand": "sample string 3",
          "vehicle_image": "sample string 4",
          "vehicle_year": 5,
          "vehicle_max_capacity": 6,
          "vehicle_approved": true
        }
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}