POST v1/company/shipment/share/detail
Request Information
URI Parameters
None.
Body Parameters
ShipmentShareDetailsRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| shipment_share_token |
Shipment share token acquired by the API |
string |
Required Data type: Text Max length: 32 Min length: 32 |
Request Format
application/json, text/json
Sample:
{
"shipment_share_token": "sample string 1"
}
Response Information
Resource Description
BaseMetaResultModelOfShipmentShareDetailResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| response | ShipmentShareDetailResponse |
None. |
|
| meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{
"response": {
"shipment": null,
"driverProfile": {
"user_last_location_lat": 1.1,
"user_last_location_long": 1.1,
"user_last_location_time": "2024-11-25T22:31:54.8695063+03:00",
"user_location_distance": 1.1,
"is_company_driver": true,
"user_stats": [
{
"ufs_sq_id": 3,
"ufs_sq_text": "sample string 4",
"ufs_feedback_count": 1,
"ufs_yes_answer_count": 1,
"ufs_point_sum": 1,
"ufs_average_point": 5.0,
"ufs_average_yes": 6.0
},
{
"ufs_sq_id": 3,
"ufs_sq_text": "sample string 4",
"ufs_feedback_count": 1,
"ufs_yes_answer_count": 1,
"ufs_point_sum": 1,
"ufs_average_point": 5.0,
"ufs_average_yes": 6.0
}
],
"user_vehicles": [
{
"vehicle_id": 1,
"vehicle_company_id": "sample string 2",
"vehicle_user_id": "sample string 3",
"vehicle_type": 4,
"vehicle_licence_plate": "sample string 5",
"vehicle_brand": "sample string 6",
"vehicle_image": "sample string 7",
"vehicle_reg_image_front": "sample string 8",
"vehicle_reg_image_back": "sample string 9",
"vehicle_insurance_image": "sample string 10",
"vehicle_insurance_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_kbelgesi_image": "sample string 11",
"vehicle_trailer_type": 12,
"vehicle_year": 13,
"vehicle_max_capacity": 14,
"vehicle_max_tonnage": 15,
"vehicle_has_adr": true,
"vehicle_date_time": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_approved": true,
"vehicle_is_rental": true,
"vehicle_rent_start_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_rent_end_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_rent_document": "sample string 20",
"vehicle_enabled": true,
"vehicle_create_user_uid": "sample string 22",
"vehicle_identity_number": "sample string 23",
"vehicle_active_shipment_count": 24,
"vehicle_driver_name": "sample string 25",
"vehicle_drivers": [
{
"user_id": "sample string 2",
"user_first_name": "sample string 3",
"user_cell_number": "sample string 4",
"user_citizenship_number": "sample string 5",
"user_image": "sample string 6",
"user_mailing_address": "sample string 7",
"user_driving_license_image_front": "sample string 8",
"user_driving_license_code": "sample string 9",
"user_driving_license_image_back": "sample string 10",
"user_src_document_image": "sample string 11",
"user_psyc_document_image": "sample string 12",
"user_available": true,
"user_active": true,
"user_rating": 1,
"user_key": "sample string 13",
"user_secret": "sample string 14",
"user_type": 15,
"user_insurance_approved": true,
"user_create_date": "2024-11-25T22:31:54.8695063+03:00",
"enable_shipment_notifications": true,
"user_birthdate": "2024-11-25T22:31:54.8695063+03:00",
"user_is_busy": true,
"user_total_score": 22,
"user_league_rank": 23,
"user_league_level": "sample string 24",
"user_param_card_status": 1,
"user_param_card_guid": null,
"user_is_company_driver": true,
"user_invoice_service_guid": "sample string 26",
"user_is_test": true,
"user_timezone": "sample string 27",
"user_cell_country_phone_code": 28,
"country_phone_code": 0,
"user_iban": "sample string 29",
"user_tk_iban": "sample string 30"
},
{
"user_id": "sample string 2",
"user_first_name": "sample string 3",
"user_cell_number": "sample string 4",
"user_citizenship_number": "sample string 5",
"user_image": "sample string 6",
"user_mailing_address": "sample string 7",
"user_driving_license_image_front": "sample string 8",
"user_driving_license_code": "sample string 9",
"user_driving_license_image_back": "sample string 10",
"user_src_document_image": "sample string 11",
"user_psyc_document_image": "sample string 12",
"user_available": true,
"user_active": true,
"user_rating": 1,
"user_key": "sample string 13",
"user_secret": "sample string 14",
"user_type": 15,
"user_insurance_approved": true,
"user_create_date": "2024-11-25T22:31:54.8695063+03:00",
"enable_shipment_notifications": true,
"user_birthdate": "2024-11-25T22:31:54.8695063+03:00",
"user_is_busy": true,
"user_total_score": 22,
"user_league_rank": 23,
"user_league_level": "sample string 24",
"user_param_card_status": 1,
"user_param_card_guid": null,
"user_is_company_driver": true,
"user_invoice_service_guid": "sample string 26",
"user_is_test": true,
"user_timezone": "sample string 27",
"user_cell_country_phone_code": 28,
"country_phone_code": 0,
"user_iban": "sample string 29",
"user_tk_iban": "sample string 30"
}
],
"vehicle_trailer_types": [
1,
2
],
"vehicle_specs_uid": "sample string 27"
},
{
"vehicle_id": 1,
"vehicle_company_id": "sample string 2",
"vehicle_user_id": "sample string 3",
"vehicle_type": 4,
"vehicle_licence_plate": "sample string 5",
"vehicle_brand": "sample string 6",
"vehicle_image": "sample string 7",
"vehicle_reg_image_front": "sample string 8",
"vehicle_reg_image_back": "sample string 9",
"vehicle_insurance_image": "sample string 10",
"vehicle_insurance_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_kbelgesi_image": "sample string 11",
"vehicle_trailer_type": 12,
"vehicle_year": 13,
"vehicle_max_capacity": 14,
"vehicle_max_tonnage": 15,
"vehicle_has_adr": true,
"vehicle_date_time": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_approved": true,
"vehicle_is_rental": true,
"vehicle_rent_start_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_rent_end_date": "2024-11-25T22:31:54.8695063+03:00",
"vehicle_rent_document": "sample string 20",
"vehicle_enabled": true,
"vehicle_create_user_uid": "sample string 22",
"vehicle_identity_number": "sample string 23",
"vehicle_active_shipment_count": 24,
"vehicle_driver_name": "sample string 25",
"vehicle_drivers": [
{
"user_id": "sample string 2",
"user_first_name": "sample string 3",
"user_cell_number": "sample string 4",
"user_citizenship_number": "sample string 5",
"user_image": "sample string 6",
"user_mailing_address": "sample string 7",
"user_driving_license_image_front": "sample string 8",
"user_driving_license_code": "sample string 9",
"user_driving_license_image_back": "sample string 10",
"user_src_document_image": "sample string 11",
"user_psyc_document_image": "sample string 12",
"user_available": true,
"user_active": true,
"user_rating": 1,
"user_key": "sample string 13",
"user_secret": "sample string 14",
"user_type": 15,
"user_insurance_approved": true,
"user_create_date": "2024-11-25T22:31:54.8695063+03:00",
"enable_shipment_notifications": true,
"user_birthdate": "2024-11-25T22:31:54.8695063+03:00",
"user_is_busy": true,
"user_total_score": 22,
"user_league_rank": 23,
"user_league_level": "sample string 24",
"user_param_card_status": 1,
"user_param_card_guid": null,
"user_is_company_driver": true,
"user_invoice_service_guid": "sample string 26",
"user_is_test": true,
"user_timezone": "sample string 27",
"user_cell_country_phone_code": 28,
"country_phone_code": 0,
"user_iban": "sample string 29",
"user_tk_iban": "sample string 30"
},
{
"user_id": "sample string 2",
"user_first_name": "sample string 3",
"user_cell_number": "sample string 4",
"user_citizenship_number": "sample string 5",
"user_image": "sample string 6",
"user_mailing_address": "sample string 7",
"user_driving_license_image_front": "sample string 8",
"user_driving_license_code": "sample string 9",
"user_driving_license_image_back": "sample string 10",
"user_src_document_image": "sample string 11",
"user_psyc_document_image": "sample string 12",
"user_available": true,
"user_active": true,
"user_rating": 1,
"user_key": "sample string 13",
"user_secret": "sample string 14",
"user_type": 15,
"user_insurance_approved": true,
"user_create_date": "2024-11-25T22:31:54.8695063+03:00",
"enable_shipment_notifications": true,
"user_birthdate": "2024-11-25T22:31:54.8695063+03:00",
"user_is_busy": true,
"user_total_score": 22,
"user_league_rank": 23,
"user_league_level": "sample string 24",
"user_param_card_status": 1,
"user_param_card_guid": null,
"user_is_company_driver": true,
"user_invoice_service_guid": "sample string 26",
"user_is_test": true,
"user_timezone": "sample string 27",
"user_cell_country_phone_code": 28,
"country_phone_code": 0,
"user_iban": "sample string 29",
"user_tk_iban": "sample string 30"
}
],
"vehicle_trailer_types": [
1,
2
],
"vehicle_specs_uid": "sample string 27"
}
],
"user_vehicle_is_rental": true,
"user_vehicle_is_company_vehicle": true,
"user_id": 6,
"user_uid": "sample string 7",
"user_first_name": "sample string 8",
"user_cell_number": "sample string 9",
"user_citizenship_number": "sample string 10",
"user_image": "sample string 11",
"user_mailing_address": "sample string 12",
"user_driving_license_image_front": "sample string 13",
"user_driving_license_image_back": "sample string 14",
"user_src_document_image": "sample string 15",
"user_psyc_document_image": "sample string 16",
"user_available": true,
"user_active": true,
"user_rating": 1,
"user_type": 17,
"user_insurance_approved": true,
"user_create_date": "2024-11-25T22:31:54.8695063+03:00",
"enable_shipment_notifications": true,
"user_confirmation_date": "2024-11-25T22:31:54.8695063+03:00",
"user_confirmation_company_user_uid": "sample string 21",
"company_name": "sample string 23",
"user_vehicle_licence_plate": "sample string 24",
"user_confirmation_company_user": "sample string 25",
"filter_user_id": 26,
"user_iban": "sample string 27",
"user_tk_iban": "sample string 28"
},
"driverPerformanceStats": {
"user_id": "sample string 1",
"total_user_distance": 2.0,
"total_num_completed": 3,
"avg_departure_error_minutes": 4,
"avg_arrival_error_minutes": 5,
"avg_departure_points": 6.0,
"avg_arrival_points": 7.0,
"avg_general_points": 8.0
},
"documents": [
{
"id": 1,
"shipment_uid": "sample string 2",
"shipment_stop_id": 3,
"document_image": [
"sample string 1",
"sample string 2"
],
"document_type": 4,
"create_date": "2024-11-25T22:31:54.8695063+03:00",
"create_user_uid": "sample string 6",
"location_lat": 1.1,
"location_long": 1.1
},
{
"id": 1,
"shipment_uid": "sample string 2",
"shipment_stop_id": 3,
"document_image": [
"sample string 1",
"sample string 2"
],
"document_type": 4,
"create_date": "2024-11-25T22:31:54.8695063+03:00",
"create_user_uid": "sample string 6",
"location_lat": 1.1,
"location_long": 1.1
}
]
},
"meta": {
"status_code": 1,
"status_message": "sample string 2"
}
}