Addressbook_v4_response.json

{
	"title": "Addressbook v4 Response",
	"type": "object",
	"properties": {
		"created_timestamp": {
			"type": "integer",
			"title": "Created timestamp",
			"description": "Timestamp the response created"
		},
		"address_id": {
			"type": "integer",
			"title": "Address ID",
			"description": "Address unique 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": "User unique 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": "object",
			"additionalProperties": { "type": "string" },
			"title": "Address custom data",
			"description": "Address custom data"
		},
		"schedule": {
			"type": "array",
			"nullable": true,
			"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": "Scheudle 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", "null"],
			"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": "In how many route is icluded"
		},
		"visited_count": {
			"type": "integer",
			"title": "Visited Count",
			"description": "How many route destination were visited"
		},
		"last_visited_timestamp": {
			"type": "integer",
			"title": "Last visited timestamp",
			"description": "Last visited timestamp"
		},
		"last_routed_timestamp": {
			"type": ["integer", "null"],
			"title": "Last routed timestamp",
			"description": "Last routed timestamp"
		},
		"local_time_window_start": {
			"type": ["integer", "null"],
			"title": "Local time window start",
			"description": "Local time window start"
		},
		"local_time_window_end": {
			"type": ["integer", "null"],
			"title": "Local time window end",
			"description": "Local time window end"
		},
		"local_time_window_start_2": {
			"type": ["integer", "null"],
			"title": "Local time window start 2",
			"description": "Local time window start 2"
		},
		"local_time_window_end_2": {
			"type": ["integer", "null"],
			"title": "Local time window end 2",
			"description": "Local time window end 2"
		},
		"service_time": {
			"type": ["integer", "null"],
			"title": "Service time",
			"description": "Service time"
		},
		"local_timezone_string": {
			"type": ["string", "null"],
			"title": "Local timezone string",
			"description": "Local timezone string"
		},
		"color": {
			"type": ["string", "null"],
			"title": "Color",
			"description": "Color of an address"
		},
		"address_icon": {
			"type": ["string", "null"],
			"title": "Address icon",
			"description": "URL to an address icon file"
		},
		"address_stop_type": {
			"type": "string",
			"enum": ["DELIVERY","PICKUP","BREAK","MEETUP","SERVICE","VISIT","DRIVEBY"],
			"name": "address_stop_type",
			"title": "Address stop type",
			"description": "The type of stop that this is (DELIVERY,PICKUP,BREAK,MEETUP,SERVICE,VISIT,DRIVEBY)"
		},
		"address_cube": {
			"type": ["number", "null"],
			"name": "address_cube",
			"title": "Address Cube",
			"description": "The cubic volume of the cargo being delivered or picked up at the address"
		},
		"address_pieces": {
			"type": ["integer", "null"],
			"name": "address_pieces",
			"title": "Address Pieces",
			"description": "The item quantity of the cargo being delivered or picked up at the address"
		},
		"address_reference_no": {
			"type": ["string", "null"],
			"name": "address_reference_no",
			"title": "Address Reference NO",
			"description": "The reference number for the address"
		},
		"address_revenue": {
			"type": ["number", "null"],
			"name": "address_revenue",
			"title": "Address Revenue",
			"description": "The total revenue for the address"
		},
		"address_weight": {
			"type": ["number", "null"],
			"name": "address_weight",
			"title": "Address Weight",
			"description": "Weight of the cargo being delivered or picked up at the address"
		},
		"address_priority": {
			"type": ["integer", "null"],
			"name": "address_priority",
			"title": "Address Priority",
			"description": "0 is the highest priority; n has higher priority than n + 1"
		},
		"address_customer_po": {
			"type": ["string", "null"],
			"name": "address_customer_po",
			"title": "Address Customer PO",
			"description": "The customer purchase order for the address"
		},
		"is_assigned": {
			"type": "boolean",
			"title": "Is Assigned",
			"description": "If true, a location assigned to a route."
		}
	}
}