Get Oort Routes By Id

GET

/oort/routes/:id_type/:id

GET

/oort/routes/:id_type/:id

1 curl https://localhost:5000/oort/routes/route_id/id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "route": {
3     "schema_version": 42,
4     "task_group_ids": [
5       "foo"
6     ],
7     "driver_id": "foo",
8     "_id": "foo",
9     "org_id": "foo",
10     "completed": false,
11     "completed_at": "foo"
12   },
13   "driver": {
14     "schema_version": 42,
15     "active": true,
16     "email_address_primary": "foo",
17     "email_address_secondary": "foo",
18     "phone_number_primary": "foo",
19     "phone_number_secondary": "foo",
20     "user_id": "foo",
21     "first_name": "foo",
22     "last_name": "foo",
23     "_id": "foo",
24     "org_id": "foo",
25     "last_seen_at_location": {
26       "type": "foo",
27       "geometry": {
28         "bbox": [
29           "foo"
30         ],
31         "type": "foo",
32         "coordinates": [
33           "foo"
34         ]
35       },
36       "properties": {},
37       "bbox": [
38         "foo"
39       ],
40       "id": 42
41     },
42     "last_seen_at_timestamp": "foo"
43   },
44   "task_groups": [
45     {
46       "task_group": {
47         "schema_version": 42,
48         "_id": "foo",
49         "order_id": "foo",
50         "order_short_id": "foo",
51         "task_ids": [
52           "foo"
53         ],
54         "line_items": [
55           {
56             "created_at": "foo",
57             "item": "base_rate",
58             "quantity": 42,
59             "rate": 42,
60             "comment": "foo"
61           }
62         ],
63         "payables_invoice_id": "foo",
64         "shipper_org_id": "foo",
65         "courier_org_id": "foo",
66         "route_id": "foo"
67       },
68       "tasks": [
69         {
70           "task": {
71             "schema_version": 42,
72             "location": {
73               "type": "foo",
74               "geometry": {
75                 "bbox": [
76                   "foo"
77                 ],
78                 "type": "foo",
79                 "coordinates": [
80                   "foo"
81                 ]
82               },
83               "properties": {},
84               "bbox": [
85                 "foo"
86               ],
87               "id": 42
88             },
89             "action": "pickup",
90             "primary_point_of_contact_id": "foo",
91             "secondary_point_of_contact_id": "foo",
92             "arrive_by": "foo",
93             "arrive_at": "foo",
94             "comments": "foo",
95             "_id": "foo",
96             "order_id": "foo",
97             "order_short_id": "foo",
98             "created_by_org_id": "foo",
99             "created_by_user_id": "foo",
100             "cargo_ids": [
101               "foo"
102             ],
103             "milestone_ids": [
104               "foo"
105             ],
106             "incident_ids": [
107               "foo"
108             ],
109             "insurance_ids": [
110               "foo"
111             ],
112             "flight_number": "foo",
113             "completed": false,
114             "completed_at": "foo"
115           },
116           "cargos": [
117             {
118               "schema_version": 42,
119               "cargo_type": "spare_parts",
120               "quantity": 42,
121               "weight_pounds": 42,
122               "length_inches": 42,
123               "width_inches": 42,
124               "height_inches": 42,
125               "_id": "foo",
126               "order_id": "foo",
127               "order_short_id": "foo"
128             }
129           ],
130           "milestones": [
131             {
132               "schema_version": 42,
133               "type": "image",
134               "requestor_comments": "foo",
135               "_id": "foo",
136               "order_id": "foo",
137               "order_short_id": "foo",
138               "task_id": "foo",
139               "completed_at_timestamp": "foo",
140               "completed_at_geojson_feature": {
141                 "type": "foo",
142                 "geometry": {
143                   "bbox": {},
144                   "type": "foo",
145                   "coordinates": {}
146                 },
147                 "properties": {},
148                 "bbox": [
149                   "foo"
150                 ],
151                 "id": 42
152               },
153               "completed_by_user_id": "foo",
154               "completed": true,
155               "requested": true,
156               "completor_comments": "foo",
157               "chrt_comments": "foo",
158               "s3_milestone_file_metadata_ids": [
159                 "foo"
160               ],
161               "decoded_scans": [
162                 "foo"
163               ]
164             }
165           ]
166         }
167       ]
168     }
169   ]
170 }

Path parameters

id_typeenumRequired

Allowed values:

idstringRequired

Query parameters

include_driverbooleanOptionalDefaults to true

Include driver information (Default: True)

include_task_groupsbooleanOptionalDefaults to true

Include task groups (Default: True)

include_tasksbooleanOptionalDefaults to false

Include tasks (Default: False)

include_cargobooleanOptionalDefaults to false

Include cargo (Default: False)

include_milestonesbooleanOptionalDefaults to false

Include milestones (Default: False)

Response

Successful Response

routeobject

driverobject or null

task_groupslist of objects or null

Get Oort Routes By Id

Path parameters

Headers

Query parameters

Response

Errors