POST v1/company/delegate/list
WEB - List delegate companies of the company
Request Information
URI Parameters
None.
Body Parameters
CompanyRequestModelName | Description | Type | Additional 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. |
|
is_reliable_driver | boolean |
None. |
|
only_assigned_company_vehicle | boolean |
None. |
|
driver_with_all_assigned_vehicles | boolean |
None. |
|
has_paging | boolean |
None. |
|
page_number | integer |
None. |
|
page_length | integer |
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, "is_reliable_driver": true, "only_assigned_company_vehicle": true, "driver_with_all_assigned_vehicles": true, "has_paging": true, "page_number": 1, "page_length": 1, "user_company_id": "sample string 5", "user_id": "sample string 6", "user_signature": "sample string 7" }
Response Information
Resource Description
WEB - List delegate companies of the company
BaseMetaResultModelOfCompanyDelegateCompany[]Name | Description | Type | Additional information |
---|---|---|---|
response | Collection of CompanyDelegateCompany |
None. |
|
meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{ "response": [ { "delegate_company_uid": "sample string 3", "delegate_company_name": "sample string 4" }, { "delegate_company_uid": "sample string 3", "delegate_company_name": "sample string 4" } ], "meta": { "status_code": 1, "status_message": "sample string 2" } }