POST v1/company/shipmentTemplate/list

WEB - List shipment templates of the company

Request Information

URI Parameters

None.

Body Parameters

CompanyRequestModel
NameDescriptionTypeAdditional information
only_available_driver

Set true for only available driver list

boolean

None.

shipment_uid

string

None.

required_adr

boolean

None.

is_company_driver

boolean

None.

only_assigned_company_vehicle

boolean

None.

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:
{
  "only_available_driver": true,
  "shipment_uid": "sample string 2",
  "required_adr": true,
  "is_company_driver": true,
  "only_assigned_company_vehicle": true,
  "user_company_id": "sample string 6",
  "user_id": "sample string 7",
  "user_signature": "sample string 8"
}

Response Information

Resource Description

WEB - List shipment templates of the company

BaseMetaResultModelOfShipmentTemplate[]
NameDescriptionTypeAdditional information
response

Collection of ShipmentTemplate

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": [
    {
      "shipment_template_id": 1,
      "shipment_template_description": "sample string 3",
      "shipment_shape_type_id": 1,
      "shipment_shape_type_type_id": 1,
      "shipment_type_id": 1,
      "shipment_vehicle_type_id": 1,
      "shipment_pallet_count": 1,
      "shipment_vehicle_trailer_type_id": 1,
      "shipment_vehicle_base_slab_id": 1,
      "shipment_vehicle_capacity_type_id": 1,
      "shipment_payment_type_id": 1,
      "shipment_departure_date": "2018-11-21T08:28:51.7705427+03:00",
      "shipment_departure_address_id": 1,
      "shipment_departure_contact_name": "sample string 4",
      "shipment_departure_contact_phone_number": "sample string 5",
      "shipment_destination_address_id": 1,
      "shipment_distance": 1,
      "shipment_proposal_cost": 1,
      "shipment_cubic_meter": "sample string 6",
      "shipment_weight": "sample string 7",
      "shipment_length": "sample string 8",
      "shipment_remark": "sample string 9",
      "shipment_date_time": "2018-11-21T08:28:51.7705427+03:00",
      "modification_time": "2018-11-21T08:28:51.7705427+03:00",
      "shipment_temperature": 11,
      "shipment_has_adr": true,
      "shipment_destinations": [
        {
          "id": 1,
          "shipment_template_id": 2,
          "shipment_arrival_date": "2018-11-21T08:28:51.7705427+03:00",
          "shipment_arrival_address_id": 3,
          "shipment_arrival_contact_name": "sample string 4",
          "shipment_arrival_contact_phone_number": "sample string 5"
        },
        {
          "id": 1,
          "shipment_template_id": 2,
          "shipment_arrival_date": "2018-11-21T08:28:51.7705427+03:00",
          "shipment_arrival_address_id": 3,
          "shipment_arrival_contact_name": "sample string 4",
          "shipment_arrival_contact_phone_number": "sample string 5"
        }
      ]
    },
    {
      "shipment_template_id": 1,
      "shipment_template_description": "sample string 3",
      "shipment_shape_type_id": 1,
      "shipment_shape_type_type_id": 1,
      "shipment_type_id": 1,
      "shipment_vehicle_type_id": 1,
      "shipment_pallet_count": 1,
      "shipment_vehicle_trailer_type_id": 1,
      "shipment_vehicle_base_slab_id": 1,
      "shipment_vehicle_capacity_type_id": 1,
      "shipment_payment_type_id": 1,
      "shipment_departure_date": "2018-11-21T08:28:51.7705427+03:00",
      "shipment_departure_address_id": 1,
      "shipment_departure_contact_name": "sample string 4",
      "shipment_departure_contact_phone_number": "sample string 5",
      "shipment_destination_address_id": 1,
      "shipment_distance": 1,
      "shipment_proposal_cost": 1,
      "shipment_cubic_meter": "sample string 6",
      "shipment_weight": "sample string 7",
      "shipment_length": "sample string 8",
      "shipment_remark": "sample string 9",
      "shipment_date_time": "2018-11-21T08:28:51.7705427+03:00",
      "modification_time": "2018-11-21T08:28:51.7705427+03:00",
      "shipment_temperature": 11,
      "shipment_has_adr": true,
      "shipment_destinations": [
        {
          "id": 1,
          "shipment_template_id": 2,
          "shipment_arrival_date": "2018-11-21T08:28:51.7705427+03:00",
          "shipment_arrival_address_id": 3,
          "shipment_arrival_contact_name": "sample string 4",
          "shipment_arrival_contact_phone_number": "sample string 5"
        },
        {
          "id": 1,
          "shipment_template_id": 2,
          "shipment_arrival_date": "2018-11-21T08:28:51.7705427+03:00",
          "shipment_arrival_address_id": 3,
          "shipment_arrival_contact_name": "sample string 4",
          "shipment_arrival_contact_phone_number": "sample string 5"
        }
      ]
    }
  ],
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}