POST v1/company/feedback

WEB - Return the list of feedback questions for a shipment feedback

Request Information

URI Parameters

None.

Body Parameters

ShipmentFeedbackRequestModel
NameDescriptionTypeAdditional information
shipment_id

Shipment ID to exeecute the feedback for

string

Required

feedback_comment

Optional text comment for the shipment

string

None.

feedback_email

Optional text email for the shipment

string

None.

feedback_questions

List of shipment feedback questions and their answers

Collection of ShipmentFeedbackQuestion

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",
  "feedback_comment": "sample string 2",
  "feedback_email": "sample string 3",
  "feedback_questions": [
    {
      "sq_id": 3,
      "sq_text": "sample string 4",
      "shfq_answer": 64,
      "shfq_point": 64
    },
    {
      "sq_id": 3,
      "sq_text": "sample string 4",
      "shfq_answer": 64,
      "shfq_point": 64
    }
  ],
  "user_company_id": "sample string 4",
  "user_id": "sample string 5",
  "user_signature": "sample string 6"
}

Response Information

Resource Description

WEB - Return the list of feedback questions for a shipment feedback

BaseMetaResultModelOfShipmentFeedbackResponseModel
NameDescriptionTypeAdditional information
response

ShipmentFeedbackResponseModel

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "feedback": {
      "shf_id": 1,
      "shipment_id": 2,
      "feedback_company_id": 3,
      "feedback_company_user_id": 4,
      "feedback_driver_user_id": 5,
      "feedback_date_time": "2024-11-25T22:57:12.3338327+03:00",
      "feedback_comment": "sample string 7",
      "feedback_is_autoresponse": true,
      "feedback_user_email": "sample string 10"
    },
    "feedback_questions": [
      {
        "sq_id": 3,
        "sq_text": "sample string 4",
        "shfq_answer": 64,
        "shfq_point": 64
      },
      {
        "sq_id": 3,
        "sq_text": "sample string 4",
        "shfq_answer": 64,
        "shfq_point": 64
      }
    ]
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}