Get by ID full details

GET

/oort/task_groups/v1/:id/full

GET

/oort/task_groups/v1/:id/full

1 curl https://localhost:8000/oort/task_groups/v1/id/full \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "task_group": {
3     "schema_version": 1,
4     "_id": "string",
5     "order_id": "string",
6     "order_short_id": "string",
7     "task_ids": [
8       "string"
9     ],
10     "courier_org_id": "string",
11     "order_cancelled": false,
12     "status": "not_started",
13     "driver_id": "string",
14     "started_at": "2024-01-15T09:30:00Z",
15     "completed_at": "2024-01-15T09:30:00Z",
16     "completed": false,
17     "paused": false
18   },
19   "tasks_with_details": [
20     {
21       "task": {
22         "schema_version": 1,
23         "_id": "string",
24         "order_id": "string",
25         "order_short_id": "string",
26         "created_by_org_id": "string",
27         "created_by_user_id": "string",
28         "location": {
29           "type": "string",
30           "geometry": {
31             "bbox": [
32               "string"
33             ],
34             "type": "string",
35             "coordinates": [
36               "string"
37             ]
38           },
39           "bbox": [
40             "string"
41           ],
42           "properties": {
43             "address": "string",
44             "name": "string",
45             "mapbox_id": "string"
46           },
47           "id": 1
48         },
49         "action": "pickup",
50         "shipper_contact_info_ids": [
51           "string"
52         ],
53         "arrive_by": "2024-01-15T09:30:00Z",
54         "arrive_at": "2024-01-15T09:30:00Z",
55         "comments": "string",
56         "flight_number": "string",
57         "order_cancelled": false,
58         "completed": false,
59         "completed_at": "2024-01-15T09:30:00Z",
60         "cargo_ids": [
61           "string"
62         ],
63         "milestone_ids": [
64           "string"
65         ]
66       },
67       "milestones": [
68         {
69           "schema_version": 1,
70           "type": "image",
71           "_id": "string",
72           "order_id": "string",
73           "order_short_id": "string",
74           "task_id": "string",
75           "completed": true,
76           "requested_by_shipper": true,
77           "requestor_comments": "string",
78           "completed_at_timestamp": "2024-01-15T09:30:00Z",
79           "completed_at_geojson_feature": {
80             "type": "string",
81             "geometry": {
82               "bbox": [
83                 "string"
84               ],
85               "type": "string",
86               "coordinates": [
87                 "string"
88               ]
89             },
90             "bbox": [
91               "string"
92             ],
93             "properties": {
94               "address": "string",
95               "name": "string",
96               "mapbox_id": "string"
97             },
98             "id": 1
99           },
100           "completed_by_user_id": "string",
101           "milestone_s3_object_metadata_ids": [
102             "string"
103           ],
104           "decoded_scans": [
105             "string"
106           ],
107           "completor_comments": "string",
108           "chrt_comments": "string",
109           "notification_email_ids": [
110             "string"
111           ],
112           "notification_sms_ids": [
113             "string"
114           ],
115           "notification_push_ids": [
116             "string"
117           ],
118           "notification_voice_ids": [
119             "string"
120           ]
121         }
122       ],
123       "cargos": [
124         {
125           "schema_version": 1,
126           "cargo_type": "spare_parts",
127           "_id": "string",
128           "order_id": "string",
129           "order_short_id": "string",
130           "quantity": 1,
131           "weight_pounds": 1.1,
132           "length_inches": 1.1,
133           "width_inches": 1.1,
134           "height_inches": 1.1,
135           "device_ids": [
136             "string"
137           ],
138           "status": "awaiting_pickup"
139         }
140       ]
141     }
142   ]
143 }

Retrieves a specific task group with complete tasks, milestones, and cargo information.

Authentication

AuthorizationBearer

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

Path Parameters

idstringRequired

Response

Successful Response

task_groupobject

tasks_with_detailslist of objects

Authentication

Path Parameters

Response

Errors