POST v1/company/shipment/document-list

WEB - LIST SHIPMENT DOCUMENTS

Request Information

URI Parameters

None.

Body Parameters

ShipmentDocumentListRequestModel
NameDescriptionTypeAdditional information
shipment_uid

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

Response Information

Resource Description

WEB - LIST SHIPMENT DOCUMENTS

BaseMetaResultModelOfShipmentDocumentModel[]
NameDescriptionTypeAdditional information
response

Collection of ShipmentDocumentModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": [
    {
      "id": 1,
      "shipment_uid": "sample string 2",
      "shipment_stop_id": 3,
      "document_image": [
        "sample string 1",
        "sample string 2"
      ],
      "document_type": 4,
      "create_date": "2018-05-21T12:17:28.3423164+03:00",
      "create_user_uid": "sample string 6"
    },
    {
      "id": 1,
      "shipment_uid": "sample string 2",
      "shipment_stop_id": 3,
      "document_image": [
        "sample string 1",
        "sample string 2"
      ],
      "document_type": 4,
      "create_date": "2018-05-21T12:17:28.3423164+03:00",
      "create_user_uid": "sample string 6"
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}