Retrieve for executor operators

POST

/shipping/task_groups/expanded/for_executor_operators/v1/:task_group_id

POST

/shipping/task_groups/expanded/for_executor_operators/v1/:task_group_id

1 const url = 'https://localhost:8000/shipping/task_groups/expanded/for_executor_operators/v1/task_group_id';
2 const options = {
3   method: 'POST',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "task_group": {
3     "_id": "_id",
4     "created_by_org_id": "created_by_org_id",
5     "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
6     "order_id": "order_id",
7     "order_short_id": "order_short_id",
8     "schema_version": 1,
9     "task_group_type": "chrt_ground_provider",
10     "cancelled_at_timestamp": "2024-01-15T09:30:00Z",
11     "completed_at_timestamp": "2024-01-15T09:30:00Z",
12     "coordinator_org_id": "coordinator_org_id",
13     "created_by_user_id": "created_by_user_id",
14     "driver_id": "driver_id",
15     "exception_at_timestamp": "2024-01-15T09:30:00Z",
16     "executor_org_id": "executor_org_id",
17     "flight_leg_ids": [
18       "flight_leg_ids"
19     ],
20     "flight_setup_notes": "flight_setup_notes",
21     "in_progress_at_timestamp": "2024-01-15T09:30:00Z",
22     "messages": [
23       {
24         "message": "message",
25         "org_id": "org_id",
26         "timestamp": "2024-01-15T09:30:00Z",
27         "user_id": "user_id"
28       }
29     ],
30     "mileage_estimated": 1.1,
31     "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
32     "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
33     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
34     "provider_pay_driver_billing_ledger_period_id": "provider_pay_driver_billing_ledger_period_id",
35     "provider_pay_driver_line_item_group_id": "provider_pay_driver_line_item_group_id",
36     "provider_pay_driver_rate_sheet_id": "provider_pay_driver_rate_sheet_id",
37     "provider_pay_provider_billing_ledger_period_id": "provider_pay_provider_billing_ledger_period_id",
38     "provider_pay_provider_line_item_group_id": "provider_pay_provider_line_item_group_id",
39     "provider_pay_provider_rate_sheet_id": "provider_pay_provider_rate_sheet_id",
40     "shipper_org_id": "shipper_org_id",
41     "shipper_pay_provider_billing_ledger_period_id": "shipper_pay_provider_billing_ledger_period_id",
42     "shipper_pay_provider_line_item_group_id": "shipper_pay_provider_line_item_group_id",
43     "shipper_pay_provider_rate_sheet_id": "shipper_pay_provider_rate_sheet_id",
44     "skipped_at_timestamp": "2024-01-15T09:30:00Z",
45     "staged_at_timestamp": "2024-01-15T09:30:00Z",
46     "status": "draft",
47     "task_group_s3_object_metadata_ids": [
48       "task_group_s3_object_metadata_ids"
49     ],
50     "task_ids": [
51       "task_ids"
52     ],
53     "vehicle_type": "sedan",
54     "wait_time_total_minutes": 1.1
55   },
56   "awb_numbers": [
57     "awb_numbers"
58   ],
59   "coordinator_org_company_name": "coordinator_org_company_name",
60   "coordinator_org_handle": "coordinator_org_handle",
61   "coordinator_org_id": "coordinator_org_id",
62   "driver": {
63     "_id": "_id",
64     "org_id": "org_id",
65     "schema_version": 1,
66     "user_id": "user_id",
67     "auto_assign_enabled": true,
68     "available_according_to_driver": true,
69     "available_according_to_operators": true,
70     "email_address_primary": "email_address_primary",
71     "email_address_secondary": "email_address_secondary",
72     "first_name": "first_name",
73     "last_name": "last_name",
74     "last_seen_at_location": {
75       "geometry": {
76         "type": "GeometryCollection",
77         "geometries": [
78           {
79             "type": "LineString",
80             "coordinates": [
81               []
82             ]
83           }
84         ]
85       },
86       "type": "Feature",
87       "id": 1
88     },
89     "last_seen_at_location_city": "last_seen_at_location_city",
90     "last_seen_at_location_large_city": "last_seen_at_location_large_city",
91     "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
92     "phone_number_primary": "phone_number_primary",
93     "phone_number_secondary": "phone_number_secondary",
94     "status": "unassigned",
95     "vehicle_types": [
96       "sedan"
97     ],
98     "waiting": true
99   },
100   "executor_org_company_name": "executor_org_company_name",
101   "executor_org_handle": "executor_org_handle",
102   "executor_org_id": "executor_org_id",
103   "off_chrt_executor_org_company_name": "off_chrt_executor_org_company_name",
104   "off_chrt_executor_org_data_id": "off_chrt_executor_org_data_id",
105   "off_chrt_shipper_org_company_name": "off_chrt_shipper_org_company_name",
106   "off_chrt_shipper_org_data_id": "off_chrt_shipper_org_data_id",
107   "shipper_org_company_name": "shipper_org_company_name",
108   "shipper_org_id": "shipper_org_id",
109   "tasks_expanded": [
110     {
111       "task": {
112         "_id": "_id",
113         "created_by_org_id": "created_by_org_id",
114         "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
115         "order_id": "order_id",
116         "order_short_id": "order_short_id",
117         "schema_version": 1,
118         "task_group_id": "task_group_id"
119       },
120       "cargos": [
121         {
122           "_id": "_id",
123           "cargo_type": "spare_parts",
124           "created_by_org_id": "created_by_org_id",
125           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
126           "order_id": "order_id",
127           "order_short_id": "order_short_id",
128           "schema_version": 1
129         }
130       ],
131       "contacts": [
132         {
133           "_id": "_id",
134           "created_by_org_id": "created_by_org_id",
135           "name": "name",
136           "schema_version": 1
137         }
138       ],
139       "task_artifacts": [
140         {
141           "_id": "_id",
142           "created_by_org_id": "created_by_org_id",
143           "draft_started_at_timestamp": "2024-01-15T09:30:00Z",
144           "order_id": "order_id",
145           "order_short_id": "order_short_id",
146           "schema_version": 1,
147           "task_group_id": "task_group_id",
148           "task_id": "task_id",
149           "type": "image"
150         }
151       ]
152     }
153   ]
154 }

Retrieves an expanded task group with optional related data for executor operators (the provider org doing the work on this task group). | authz_personas=[executor_org_operators] | (OrderAndTaskGroupExpandedReq) -> (TaskGroupExpanded)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_group_idstringRequired

Request

This endpoint expects an object.

expand_cargosbooleanOptionalDefaults to false

expand_contactsbooleanOptionalDefaults to false

expand_coordinator_org_company_namebooleanOptionalDefaults to false

expand_coordinator_org_handlebooleanOptionalDefaults to false

expand_driverbooleanOptionalDefaults to false

expand_executor_org_company_namebooleanOptionalDefaults to false

expand_executor_org_handlebooleanOptionalDefaults to false

expand_notification_intents_ad_hocbooleanOptionalDefaults to false

expand_off_chrt_shipper_org_company_namebooleanOptionalDefaults to false

expand_shipper_org_company_namebooleanOptionalDefaults to false

expand_task_artifactsbooleanOptionalDefaults to false

expand_tasksbooleanOptionalDefaults to false

Response

Successful Response

task_groupobject

awb_numberslist of stringsOptional

coordinator_org_company_namestringOptional

coordinator_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

coordinator_org_idstringOptional

Must be a string starting with org_

driverobjectOptional

executor_org_company_namestringOptional

executor_org_handlestringOptionalformat: "^@[a-zA-Z0-9_-]+$"2-30 characters

Must be a string starting with @. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters.

executor_org_idstringOptional

Must be a string starting with org_

off_chrt_executor_org_company_namestringOptional

off_chrt_executor_org_data_idstringOptional

off_chrt_shipper_org_company_namestringOptional

off_chrt_shipper_org_data_idstringOptional

shipper_org_company_namestringOptional

shipper_org_idstringOptional

Must be a string starting with org_

tasks_expandedlist of objectsOptional

Errors

422

Expanded for Executor Operators V1request Unprocessable Entity Error