-
Notifications
You must be signed in to change notification settings - Fork 5
/
Addressbook_v5.json
405 lines (404 loc) · 11.2 KB
/
Addressbook_v5.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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
{
"title": "Addressbook v5",
"type": "object",
"description": "JSON schema for address bool contact object. Endpoint: https://wh.route4me.com/modules/api/v5.0/address-book",
"required": [
"address_1",
"cached_lat",
"cached_lng"
],
"properties": {
"created_timestamp": {
"type": "integer",
"title": "Created Timestamp",
"description": "Created timestamp"
},
"address_id": {
"type": "integer",
"title": "Address ID",
"description": "Address ID"
},
"address_group": {
"type": "string",
"title": "Address group",
"description": "Address group"
},
"address_alias": {
"type": "string",
"title": "Address alias",
"description": "Address alias"
},
"address_1": {
"type": "string",
"title": "Address 1",
"description": "The route Address Line 1"
},
"address_2": {
"type": "string",
"title": "Address 2",
"description": "The route Address Line 2 which is not used for geocoding"
},
"member_id": {
"type": "integer",
"title": "Member ID",
"description": "A contact owner's member ID"
},
"first_name": {
"type": "string",
"title": "First name",
"description": "The first name of the receiving address"
},
"last_name": {
"type": "string",
"title": "Last name",
"description": "The last name of the receiving party"
},
"address_email": {
"type": "string",
"title": "Address email",
"description": "Address email"
},
"address_phone_number": {
"type": "string",
"title": "Address phone number",
"description": "The phone number for the address"
},
"address_city": {
"type": "string",
"title": "Address city",
"description": "The city the address is located in"
},
"address_state_id": {
"type": "string",
"title": "Address state id",
"description": "The state the address is located in"
},
"address_country_id": {
"type": "string",
"title": "Address country id",
"description": "The country the address is located in"
},
"address_zip": {
"type": "string",
"title": "Address zip",
"description": "The zip code the address is located in"
},
"cached_lat": {
"type": "number",
"minimum": -90,
"maximum": 90,
"title": "Cached latitude",
"description": "Cached latitude"
},
"cached_lng": {
"type": "number",
"minimum": -180,
"maximum": 180,
"title": "Cached longitude",
"description": "Cached longitude"
},
"curbside_lat": {
"type": "number",
"minimum": -90,
"maximum": 90,
"title": "Curbside latitude",
"description": "Curbside latitude"
},
"curbside_lng": {
"type": "number",
"minimum": -180,
"maximum": 180,
"title": "Curbside longitude",
"description": "Curbside longitude"
},
"address_custom_data": {
"type": "array",
"items": {
"type": "string"
},
"title": "Address custom data",
"description": "Address custom data"
},
"schedule": {
"type": "array",
"title": "Schedules",
"description": "Array of the trip schedules to a location",
"items": {
"type": "object",
"title": "Schedule",
"description": "A trip schedule to a location",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If true, a location schedule is enabled during construction of a hybrid optimization"
},
"from": {
"type": "string",
"title":"From",
"description": "When schedule will be started from"
},
"mode": {
"type": "string",
"enum": ["daily", "weekly", "monthly", "annually"],
"title":"Mode",
"description": "Schedule mode"
},
"daily": {
"type": "object",
"description": "Daily schedule if the mode 'daily' was chosen",
"title": "Daily",
"properties": {
"every": {
"type": "integer",
"title": "Every",
"description": "Repeat every next N days"
}
}
},
"weekly": {
"type": "object",
"title": "Weekly",
"description": "Weekly schedule if the mode 'weekly' was chosen",
"properties": {
"every": {
"type": "integer",
"title": "Every",
"description": "Repeat every week next N days"
},
"weekdays": {
"type": "array",
"title": "Weekdays",
"description": "Array of the weekdays",
"items": {
"type": "integer",
"title": "Weekday",
"description": "Weekday as a number"
}
}
}
},
"monthly": {
"type": "object",
"title": "Monthly",
"description": "Monthly schedule if the mode 'monthly' was chosen",
"properties": {
"every": {
"type": "integer",
"title": "Every",
"description": "Repeat every month next N days"
},
"mode": {
"type": "string",
"enum": ["dates", "nth"],
"title": "Mode",
"description": "Monthly schedule mode"
},
"dates": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Dates",
"description": "Array of month days for monthly schedule if the mode 'dates' was chosen"
},
"nth": {
"type": "object",
"title": "NTH",
"description": "Monthly schedule option if the mode 'nth' was chosen",
"properties": {
"n": {
"type": "integer",
"enum": [1,2,3,4,5,-1],
"title": "N",
"description": "Which day of the time period, 1: 1st, 2: 2nd, 3: 3rd, 4: 4th, 5: 5th, -1: Last"
},
"what": {
"type": "integer",
"enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
"title": "What",
"description": "What time. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday, 8: Day, 9: Working Day, 10: Weekend"
}
}
}
}
},
"annually": {
"type": "object",
"title": "Annually",
"description": "Annually schedule if the mode 'annually' was chosen",
"properties": {
"every": {
"type": "integer",
"title": "Every",
"description": "Repeat every year next N months"
},
"use_nth": {
"type": "boolean",
"title": "Use NTH",
"description": "If true, use NTH mode"
},
"months": {
"type": "array",
"title": "Months",
"description": "Array of the months numbers",
"items": {
"type": "integer",
"description": "A month number in the year"
}
},
"nth": {
"type": "object",
"title": "NTH",
"description": "Annualy schedule option if 'use_nth' is true",
"properties": {
"n": {
"type": "integer",
"enum": [1,2,3,4,5,-1],
"title": "N",
"description": "Which day of the time period, 1: 1st, 2: 2nd, 3: 3rd, 4: 4th, 5: 5th, -1: Last"
},
"what": {
"type": "integer",
"enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
"title": "What",
"description": "What time. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday, 8: Day, 9: Working Day, 10: Weekend"
}
}
}
}
}
}
}
},
"schedule_blacklist": {
"type": "array",
"title": "Schedule blacklist",
"description": "Array of the dates, which should be excluded from a trip schedule to a location",
"items": {
"type": "array",
"description": "Comma-separated array of the dates",
"items": {
"type": "string",
"description": "A date in the string format. e.g. '2017-02-20'"
}
}
},
"in_route_count": {
"type": "integer",
"title": "In Route Count",
"description": "How many routes contain the address"
},
"visited_count": {
"type": "integer",
"title": "Visited_Count",
"description": "How many times visited the address"
},
"last_visited_timestamp": {
"type": "integer",
"title": "Last Visited Timestamp",
"description": "Last visited timestamp"
},
"last_routed_timestamp": {
"type": "integer",
"title": "Last Routed Timestamp",
"description": "Last routed timestamp"
},
"local_time_window_start": {
"type": "integer",
"title": "Time Window Start",
"description": "Time Window Start in seconds, relative to the route start date (midnight), UTC time zone. It is relative to start date because start time changes would shift time windows"
},
"local_time_window_end": {
"type": "integer",
"title": "Time Window End",
"description": "Time Window End in seconds, relative to the route start date (midnight), UTC time zone. It is relative to start datebecause start time changes would shift time windows"
},
"local_time_window_start_2": {
"type": "integer",
"title": "Time Window Start 2",
"description": "See local_time_window_start"
},
"local_time_window_end_2": {
"type": "integer",
"title": "Time Window End 2",
"description": "See local_time_window_end"
},
"service_time": {
"type": "integer",
"title": "Service time",
"description": "Consumed service time at an address."
},
"local_timezone_string": {
"type": "string",
"title": "Local timezone string",
"description": "Local timezone string"
},
"color": {
"type": "string",
"title": "Color",
"description": "Color of an address"
},
"address_icon": {
"type": "string",
"title": "Address icon",
"description": "URL to an address icon file"
},
"address_stop_type": {
"type": "string",
"enum": ["DELIVERY","PICKUP","BREAK","MEETUP","SERVICE","VISIT","DRIVEBY"],
"title": "Address stop type",
"description": "The type of stop that this is (DELIVERY,PICKUP,BREAK,MEETUP,SERVICE,VISIT,DRIVEBY)"
},
"address_cube": {
"type": "number",
"title": "Address Cube",
"description": "The cubic volume of the cargo being delivered or picked up at the address"
},
"address_pieces": {
"type": "integer",
"title": "Address Pieces",
"description": "The item quantity of the cargo being delivered or picked up at the address"
},
"address_reference_no": {
"type": "string",
"title": "Address Reference NO",
"description": "The reference number for the address"
},
"address_revenue": {
"type": "number",
"title": "Address Revenue",
"description": "The total revenue for the address"
},
"address_weight": {
"type": "number",
"title": "Address Weight",
"description": "Weight of the cargo being delivered or picked up at the address"
},
"address_priority": {
"type": "integer",
"title": "Address Priority",
"description": "0 is the highest priority; n has higher priority than n + 1"
},
"address_customer_po": {
"type": "string",
"title": "Address Customer PO",
"description": "The customer purchase order for the address"
},
"assigned_to": {
"type": "integer",
"title": "Assigned To",
"description": "A unique ID of the user, assigned to the address book contact."
},
"eligible_pickup": {
"type": "boolean",
"title": "Eligible Pickup",
"description": "If true, the address book contact is eligible to pickup."
},
"eligible_depot": {
"type": "boolean",
"title": "Eligible Depot",
"description": "If true, the address book contact is eligible to be depot."
}
}
}