POST v1/company/shipment/locationDetails

WEB - User location details for a shipment.

Request Information

URI Parameters

None.

Body Parameters

ShipmentLocationListRequestModel
NameDescriptionTypeAdditional information
shipment_id

Shipment ID of the company to list the locations for

string

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",
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

WEB - User location details for a shipment.

BaseMetaResultModelOfShipmentLocationListResponseModel
NameDescriptionTypeAdditional information
response

ShipmentLocationListResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "locations": [
      {
        "location_id": 1,
        "location_latitude": "sample string 3",
        "location_longitude": "sample string 4",
        "location_date_time": "2018-09-22T22:27:42.5744261+03:00"
      },
      {
        "location_id": 1,
        "location_latitude": "sample string 3",
        "location_longitude": "sample string 4",
        "location_date_time": "2018-09-22T22:27:42.5744261+03:00"
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}