POST v1/company/shipmentProblem

WEB - Returns the list of shipment problems for a shipment to the web user

Request Information

URI Parameters

None.

Body Parameters

CompanyShipmentProblemListRequestModel
NameDescriptionTypeAdditional information
problem_shipment_id

Shipment ID to request the list of problems

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

Response Information

Resource Description

WEB - Returns the list of shipment problems for a shipment to the web user

BaseMetaResultModelOfShipmentProblem[]
NameDescriptionTypeAdditional information
response

Collection of ShipmentProblem

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": [
    {
      "shp_id": 1,
      "shp_shipment_id": 2,
      "shp_driver_user_id": 4,
      "shp_driver_user_name": "sample string 5",
      "shp_date_time": "2024-04-19T11:29:45.2997815+03:00",
      "shp_type_id": 7,
      "shp_type_name": "sample string 8",
      "shp_duration_type_id": 9,
      "shp_duration_type_name": "sample string 10",
      "shp_comment": "sample string 11"
    },
    {
      "shp_id": 1,
      "shp_shipment_id": 2,
      "shp_driver_user_id": 4,
      "shp_driver_user_name": "sample string 5",
      "shp_date_time": "2024-04-19T11:29:45.2997815+03:00",
      "shp_type_id": 7,
      "shp_type_name": "sample string 8",
      "shp_duration_type_id": 9,
      "shp_duration_type_name": "sample string 10",
      "shp_comment": "sample string 11"
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}