-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathupdate_route_data.json
264 lines (264 loc) · 9.09 KB
/
update_route_data.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "https://github.com/route4me/json-schemas/blob/master/RouteParameters.dtd",
"title": "Route Parameters",
"type": "object",
"name": "RouteParameters",
"properties": {
"is_upload": {
"type": ["string", "null"],
"name": "is_upload",
"title": "Is Upload",
"description": "Let the R4M api know if this sdk request is coming from a file upload within your environment (for analytics)"
},
"rt": {
"type": ["boolean", "null"],
"name": "rt",
"title": "Round Trip",
"description": "The tour type of this route. rt is short for round trip, the optimization engine changes its behavior for round trip routes"
},
"disable_optimization": {
"type": ["boolean", "null"],
"name": "disable_optimization",
"title": "Disable Optimization",
"description": "By disabling optimization, the route optimization engine will not resequence the stops in your"
},
"route_name": {
"type": ["string", "null"],
"name": "route_name",
"title": "Route Name",
"description": "The name of this route. this route name will be accessible in the search API, and also will be displayed on the mobile device of a user"
},
"route_date": {
"type": ["integer", "null"],
"name": "route_date",
"title": "Route Date",
"description": "The route start date in UTC, unix timestamp seconds. Used to show users when the route will begin, also used for reporting and analytics"
},
"route_time": {
"type": ["integer"],
"default": 0,
"name": "route_time",
"title": "Route Time",
"description": "Time when the route starts (relative to route_date) (Seconds). UTC timezone as well"
},
"shared_publicly": {
"type": ["string", "null"],
"name": "shared_publicly",
"title": "Shared Publicly",
"description": "Deprecated. Specify if the route can be viewed by unauthenticated users"
},
"optimize": {
"type": ["string", "null"],
"name": "optimize",
"enum": ["Distance", "Time", "timeWithTraffic"],
"title": "Optimize",
"description": "The driving directions will be generated biased for this selection. This has no impact on route sequencing"
},
"lock_last": {
"type": ["boolean", "null"],
"name": "lock_last",
"title": "Lock Last",
"description": "A flag to indicate if the last stop in the route should be fixed"
},
"vehicle_capacity": {
"type": ["string", "null"],
"name": "vehicle_capacity",
"title": "Vehicle Capacity",
"description": "How much cargo can the vehicle carry (units, e.g. cubic meters)"
},
"vehicle_max_distance_mi": {
"type": ["string", "null"],
"name": "vehicle_max_distance_mi",
"title": "Vehicle Maximum Distance (mi)",
"description": "Max distance for a single vehicle in this route (always in miles)"
},
"distance_unit": {
"type": ["string", "null"],
"name": "distance_unit",
"title": "Distance Unit",
"description": "The distance measurement unit for the route"
},
"travel_mode": {
"type": ["string", "null"],
"enum": ["Driving", "Walking", "Trucking", "Cycling", "Transit"],
"name": "travel_mode",
"title": "Travel Mode",
"description": "The mode of travel that the directions should be optimized for"
},
"avoid": {
"type": ["string", "null"],
"name": "avoid",
"enum": ["Highways", "Tolls", "minimizeHighways", "minimizeTolls", ""],
"title": "Avoid",
"description": "Options which let the user choose which road obstacles to avoid. This has no impact on route sequencing"
},
"vehicle_id": {
"type": ["string", "null"],
"name": "vehicle_id",
"title": "Vehicle ID",
"description": "The unique internal id of a vehicle"
},
"driver_id": {
"type": ["string", "null"],
"name": "driver_id",
"title": "Driver ID",
"description": "The unique internal id of a driver"
},
"dev_lat": {
"type": ["number", "null"],
"name": "dev_lat",
"title": "Device Latitude",
"description": "The latitude location of where a mobile device was located when it made a request to create the route."
},
"dev_lng": {
"type": ["number", "null"],
"name": "dev_lng",
"title": "Device Longitude",
"description": "The longitude location of where a mobile device was located when it made a request to create the route"
},
"route_max_duration": {
"type": ["integer"],
"default": 86400,
"name": "route_max_duration",
"title": "Route Maximum Duration",
"description": "How many seconds a route can last at most. Default is 24 hours = 86400 seconds"
},
"route_email": {
"type": ["string", "null"],
"name": "route_email",
"title": "Route Email",
"format": "email",
"description": "Addresses where this route was shared after completion"
},
"route_type": {
"type": ["string", "null"],
"name": "route_type",
"title": "Route Type",
"description": "Type of route being created: ENUM(api,null)"
},
"store_route": {
"type": ["boolean", "null"],
"name": "store_route",
"title": "Store Route",
"description": "Always true"
},
"metric": {
"type": "integer",
"enum": [1, 2, 3, 4, 5],
"name": "metric",
"title": "Metric",
"description": "Integer [1, 2, 3, 4, 5]"
},
"algorithm_type": {
"type": "integer",
"enum": [1, 2, 3, 4, 5, 6, 7],
"name": "algorithm_type",
"title": "Algorithm Type",
"description": "The algorithm to be used. Integer [TSP=1, VRP=2 etc]"
},
"member_id": {
"type": ["string", "null"],
"name": "member_id",
"title": "Member ID",
"description": "User ID who is assigned to the route"
},
"ip": {
"type": ["string", "null"],
"name": "ip",
"title": "IP",
"description": "IP Address in decimal form of user who created the route"
},
"dm": {
"type": ["integer", "null"],
"name": "dm",
"title": "DM",
"description": "Undocumented/not publicly shown"
},
"dirm": {
"type": ["integer", "null"],
"name": "dirm",
"title": "Directions Method",
"description": "Undocumented/not publicly shown"
},
"parts": {
"type": ["integer", "null"],
"name": "parts",
"title": "Parts",
"description": "Legacy feature which permits a user to request an example number of optimized routes"
},
"device_id": {
"type": ["string", "null"],
"name": "device_id",
"title": "Device ID",
"description": "32 Character MD5 String ID of the device that was used to plan this route"
},
"device_type": {
"type": ["string", "null"],
"enum": ["web", "iphone", "ipad", "android_phone", "android_tablet"],
"name": "device_type",
"title": "Device Type",
"description": "The type of the device that is creating this route"
},
"has_trailer": {
"type": ["boolean", "null"],
"name": "has_trailer",
"title": "Has Trailer",
"description": "if True vehicle has trailer"
},
"trailer_weight_t": {
"type": ["number", "null"],
"name": "trailer_weight_t",
"title": "Trailer Weight (t)",
"description": "If has_trailer = true, specifies the weight of the trailer (required)"
},
"limited_weight_t": {
"type": ["number", "null"],
"name": "limited_weight_t",
"title": "Limited Weight (t)",
"description": "If travel_mode = 'Trucking', specifies the truck weight (required)"
},
"weight_per_axle_t": {
"type": ["number", "null"],
"name": "weight_per_axle_t",
"title": "Weight per Axle (t)",
"description": "If travel_mode = 'Trucking', specifies the weight per axle (required)"
},
"truck_height_meters": {
"type": ["integer", "null"],
"name": "truck_height_meters",
"title": "Truck Height Meters",
"description": "If travel_mode = 'Trucking', specifies the truck height (required)"
},
"truck_width_meters": {
"type": ["integer", "null"],
"name": "truck_width_meters",
"title": "Truck Width Meters",
"description": "If travel_mode = 'Trucking', specifies the truck width (required)"
},
"truck_length_meters": {
"type": ["integer", "null"],
"name": "truck_length_meters",
"title": "Truck Length Meters",
"description": "If travel_mode = 'Trucking', specifies the truck length (required)"
},
"min_tour_size": {
"type": ["integer", "null"],
"name": "min_tour_size",
"title": "Minimum Tour Size",
"description": "Must be > 0; the minimum number of stops allowed in a subtour. null means there is no minimum"
},
"max_tour_size": {
"type": ["integer", "null"],
"name": "max_tour_size",
"title": "Maximum Tour Size",
"description": "Must be > 0; the maximum number of stops allowed in a subtour. null means there is no maximum"
},
"optimization_quality": {
"type": ["integer", "null"],
"name": "optimization_quality",
"title": "Optimization Quality",
"description": "there are 3 types of optimization qualities that are optimizations goals (1 - Generate Optimized Routes As Quickly as Possible, 2 - Generate Routes That Look Better On A Map, 3 - Generate The Shortest And Quickest Possible Routes)"
}
}
}