Permalink
Cannot retrieve contributors at this time
{ | |
"$schema": "http://json-schema.org/draft-04/schema#", | |
"id": "https://github.com/route4me/route4me-json-schemas/blob/master/Address.dtd", | |
"title": "Address", | |
"description": "Json schema for an Address response class. See curl examples: get_route_directions, get_route_path_points", | |
"type": "object", | |
"properties": { | |
"route_destination_id": { | |
"type": "integer", | |
"title": "Route Destination ID", | |
"description": "Internal unique address identifier" | |
}, | |
"alias": { | |
"type": "string", | |
"title": "Address Alias", | |
"description": "Address Alias" | |
}, | |
"member_id": { | |
"type": "integer", | |
"title": "Member ID", | |
"description": "Member ID" | |
}, | |
"address": { | |
"type": "string", | |
"title": "Address Name", | |
"description": "The route Address Line 1" | |
}, | |
"is_depot": { | |
"type": "boolean", | |
"title": "Is Depot", | |
"description": "This address is a depot", | |
"default": "false" | |
}, | |
"timeframe_violation_state": { | |
"type": "integer", | |
"title": "Timeframe violation state", | |
"description": "State of the timeframe violation. In a response only" | |
}, | |
"timeframe_violation_time": { | |
"type": "integer", | |
"title": "Timeframe violation time", | |
"description": "Moment of the timeframe violation. In a response only" | |
}, | |
"timeframe_violation_rate": { | |
"type": "number", | |
"title": "Timeframe violation rate", | |
"description": "Rate of the timeframe violation. In a response only" | |
}, | |
"lat": { | |
"type": "number", | |
"title": "Latitude", | |
"description": "Latitude", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"lng": { | |
"type": "number", | |
"title": "Longitude", | |
"description": "Longitude", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"curbside_lat": { | |
"type": "number", | |
"title": "Curbside Latitude", | |
"description": "Curbside latitude", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"curbside_lng": { | |
"type": "number", | |
"title": "Curbside Longitude", | |
"description": "Curbside longitude", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"priority": { | |
"type": ["integer", "null"], | |
"title": "Priority", | |
"description": "0 is the highest priority; n has higher priority than n + 1" | |
}, | |
"route_id": { | |
"type": "string", | |
"title": "Route ID", | |
"description": "Parent route" | |
}, | |
"original_route_id": { | |
"type": ["string", "null"], | |
"title": "Original Route ID", | |
"description": "The original customer-specific route id assigned at route creation time." | |
}, | |
"route_name": { | |
"type": ["string", "null"], | |
"title": "Route Name", | |
"description": "Route name of a depot address" | |
}, | |
"optimization_problem_id": { | |
"type": "string", | |
"title": "Optimization Problem ID", | |
"description": "Optimization Problem ID" | |
}, | |
"sequence_no": { | |
"type": "integer", | |
"title": "Sequence No", | |
"description": "The sequence number for the address" | |
}, | |
"geocoded": { | |
"type": "boolean", | |
"title": "Geocoded", | |
"description": "True means the 'address' field was successfully geocoded" | |
}, | |
"preferred_geocoding": { | |
"type": ["integer", "null"], | |
"title": "Preferred Geocoding", | |
"description": "Index of 'geocodings' array that the user has chosen" | |
}, | |
"failed_geocoding": { | |
"type": ["boolean", "null"], | |
"title": "Failed Geocoding", | |
"description": "True means there was a geocoding attempt which failed. False means success or no geocoding" | |
}, | |
"geocodings": { | |
"type": "array", | |
"items": {"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/geocoding.dtd"}, | |
"title": "Geocodings ID" | |
}, | |
"contact_id": { | |
"type": ["integer", "null"], | |
"minimum": 0, | |
"title": "Contact ID", | |
"description": "Address book contact id (0 means not connected to the address book)" | |
}, | |
"order_id": { | |
"type": ["integer", "null"], | |
"title": "Order ID", | |
"description": "Parent order ID" | |
}, | |
"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)" | |
}, | |
"is_visited": { | |
"type": "boolean", | |
"title": "Is Visited", | |
"description": "The driver pressed the 'Visited' button", | |
"default": "false" | |
}, | |
"timestamp_last_visited": { | |
"type": ["integer", "null"], | |
"title": "Timestamp Last Vsited", | |
"description": "Timestamp when the driver presses 'Visited'" | |
}, | |
"visited_lat": { | |
"type": ["number", "null"], | |
"title": "Visited Latitude", | |
"description": "Last known check in latitude", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"visited_lng": { | |
"type": ["number", "null"], | |
"title": "Visited Longitude", | |
"description": "Last known check in longitude", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"is_departed": { | |
"type": "boolean", | |
"title": "Is Departed", | |
"description": "The driver marked the 'Departed' button" | |
}, | |
"departed_lat": { | |
"type": ["number", "null"], | |
"title": "Departed Latitude", | |
"description": "Last known departed latitude", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"departed_lng": { | |
"type": ["number", "null"], | |
"description": "Last known departed longitude", | |
"title": "Departed Longitude", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"timestamp_last_departed": { | |
"type": ["integer", "null"], | |
"title": "Timestamp Last Departed", | |
"description": "Timestamp when the driver marks the stop as 'Departed'" | |
}, | |
"group": { | |
"type": ["string", "null"], | |
"title": "Group", | |
"description": "Address group" | |
}, | |
"customer_po": { | |
"type": ["string", "null"], | |
"title": "Customer PO", | |
"description": "The customer purchase order for the address" | |
}, | |
"invoice_no": { | |
"type": ["string", "null"], | |
"title": "Invoice No", | |
"description": "The invoice number for the address" | |
}, | |
"reference_no": { | |
"type": ["string", "null"], | |
"title": "Reference NO", | |
"description": "The reference number for the address" | |
}, | |
"order_no": { | |
"type": ["string", "null"], | |
"title": "Order NO", | |
"description": "The order number for the address" | |
}, | |
"weight": { | |
"type": "number", | |
"title": "Weight", | |
"description": "Weight" | |
}, | |
"cost": { | |
"type": "number", | |
"title": "Cost", | |
"description": "The cost of the order for the address" | |
}, | |
"revenue": { | |
"type": "number", | |
"title": "Revenue", | |
"description": "The total revenue for the address" | |
}, | |
"cube": { | |
"type": "number", | |
"title": "Cube", | |
"description": "The cubic volume of the cargo being delivered or picked up at the address" | |
}, | |
"pieces": { | |
"type": "integer", | |
"title": "Pieces", | |
"description": "Pieces" | |
}, | |
"first_name": { | |
"type": ["string", "null"], | |
"title": "First name", | |
"description": "The first name of the receiving address" | |
}, | |
"last_name": { | |
"type": ["string", "null"], | |
"title": "Last name", | |
"description": "The last name of the receiving address" | |
}, | |
"email": { | |
"type": ["string", "null"], | |
"format": "email", | |
"title": "Email", | |
"description": "A valid e-mail address assigned to this stop" | |
}, | |
"phone": { | |
"type": ["string", "null"], | |
"title": "Phone", | |
"description": "Customer Phone" | |
}, | |
"destination_note_count": { | |
"type": "integer", | |
"title": "Destination Note Count", | |
"description": "How many notes have been added to this destination" | |
}, | |
"drive_time_to_next_destination": { | |
"type": "integer", | |
"title": "Drive Time to next Destination", | |
"description": "Time to next destination in seconds." | |
}, | |
"abnormal_traffic_time_to_next_destination": { | |
"type": ["integer", "null"], | |
"description": "Abnormal traffic time to next destination", | |
"title": "Abnormal traffic time to next destination" | |
}, | |
"uncongested_time_to_next_destination": { | |
"type": ["integer", "null"], | |
"title": "Uncongested Time To Next Destination", | |
"description": "Supposing that there was no traffic at all, this gives how many seconds it takes to get to the next stop." | |
}, | |
"traffic_time_to_next_destination": { | |
"type": ["integer", "null"], | |
"title": "Traffic Time To Next Destination", | |
"description": "Traffic time to a next destination." | |
}, | |
"distance_to_next_destination": { | |
"type": "number", | |
"title": "Distance to next destination", | |
"description": "Distance to next destination in route unit (the default unit is in miles)" | |
}, | |
"udu_distance_to_next_destination": { | |
"type": "number", | |
"title": "UDU Distance To Next Destination", | |
"description": "UDU distance to next destination in route unit (the default unit is in miles)" | |
}, | |
"channel_name": { | |
"type": "string", | |
"title": "Channel name", | |
"description": "Channel name" | |
}, | |
"pickup": { | |
"type": "string", | |
"title": "Pickup", | |
"description": "Alias of a pickup point." | |
}, | |
"dropoff": { | |
"type": "string", | |
"title": "Dropoff", | |
"description": "Alias of the paired pickup point." | |
}, | |
"joint": { | |
"type": "integer", | |
"title": "Joint", | |
"description": "If equal to 1, the pickup and dropoff addresses are joint (one by one despite the regular pickup-dropoff addresses when it's possible to have multiple pickup addresses with one dropoff address)." | |
}, | |
"generated_time_window_start": { | |
"type": ["integer", "null"], | |
"title": "Generated Time Window Start", | |
"description": "Generated Time Window Start in seconds" | |
}, | |
"generated_time_window_end": { | |
"type": ["integer", "null"], | |
"title": "Generated Time Window End", | |
"description": "Generated Time Window End in seconds" | |
}, | |
"time_window_start": { | |
"type": ["integer", "null"], | |
"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 datebecause start time changes would shift time windows" | |
}, | |
"time_window_end": { | |
"type": ["integer", "null"], | |
"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" | |
}, | |
"time_window_start_2": { | |
"type": ["integer", "null"], | |
"title": "Time Window Start 2", | |
"description": "See time_window_start" | |
}, | |
"time_window_end_2": { | |
"type": ["integer", "null"], | |
"title": "Time Window End 2", | |
"description": "See time_window_end" | |
}, | |
"geofence_detected_visited_timestamp": { | |
"type": ["integer", "null"], | |
"title": "Geofence detected visited timestamp", | |
"description": "Timestamp of a geofence detected visited" | |
}, | |
"geofence_detected_departed_timestamp": { | |
"type": ["integer", "null"], | |
"title": "Geofence detected departed timestamp", | |
"description": "Timestamp of a geofence detected departed" | |
}, | |
"geofence_detected_service_time": { | |
"type": ["integer", "null"], | |
"title": "Geofence detected service time", | |
"description": "The service time of a detected geofence" | |
}, | |
"geofence_detected_visited_lat": { | |
"type": ["number", "null"], | |
"title": "Geofence detected visited lat", | |
"description": "Latitude of a visited detected geofence", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"geofence_detected_visited_lng": { | |
"type": ["number", "null"], | |
"title": "Geofence detected visited lng", | |
"description": "Longitude of a visited detected geofence", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"geofence_detected_departed_lat": { | |
"type": ["number", "null"], | |
"title": "Geofence detected departed lat", | |
"description": "Latitude of a departed detected geofence", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"geofence_detected_departed_lng": { | |
"type": ["number", "null"], | |
"title": "Geofence detected departed lng", | |
"description": "Longitude of a departed detected geofence", | |
"minimum": -180, | |
"maximum": 180 | |
}, | |
"time": { | |
"type": "integer", | |
"title": "Time", | |
"description": "Service time (seconds)" | |
}, | |
"tracking_number": { | |
"type": "string", | |
"title": "Tracking Number", | |
"description": "Systemwide unique code, which permits end-users (recipients) to track the status of their order" | |
}, | |
"custom_fields": { | |
"type": "object", | |
"additionalProperties": { "type": "string" }, | |
"description": "Any unrecognized fields from the original CSV upload will be found here", | |
"title": "Custom Fields" | |
}, | |
"custom_fields_str_json": { | |
"type": "string", | |
"title": "Custom fields JSON string", | |
"description": "JSON string representation of the custom fields" | |
}, | |
"custom_fields_config": { | |
"type": ["object", "null"], | |
"additionalProperties": {"type": "string"}, | |
"title": "Custom fields configuration", | |
"description": "Configuration of the custom fields" | |
}, | |
"custom_fields_config_str_json": { | |
"type": ["string", "null"], | |
"title": "Custom fields config JSON string", | |
"description": "JSON string representation of the custom fields configuration" | |
}, | |
"notes": { | |
"type": "array", | |
"items": {"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/note.dtd"}, | |
"title": "Notes", | |
"description": "Notes" | |
}, | |
"bundle_count": { | |
"type": "integer", | |
"title": "Bundle Count", | |
"description": "Count of the bundled addresses." | |
}, | |
"bundle_items": { | |
"type": "object", | |
"readonly": true, | |
"title": "Bundle Items", | |
"description": "Additional bundle items", | |
"properties": { | |
"cube": { | |
"type": "number", | |
"title": "Cube", | |
"description": "Summary cube value of the bundled addresses." | |
}, | |
"revenue": { | |
"type": "number", | |
"title": "Revenue", | |
"description": "Summary revenue value of the bundled addresses." | |
}, | |
"pieces": { | |
"type": "integer", | |
"title": "Pieces", | |
"description": "Summary pieces value of the bundled addresses." | |
}, | |
"weight": { | |
"type": "number", | |
"title": "Weight", | |
"description": "Summary weight value of the bundled addresses." | |
}, | |
"cost": { | |
"type": "number", | |
"title": "Cost", | |
"description": "Summary cost value of the bundled addresses." | |
}, | |
"service_time": { | |
"type": "integer", | |
"title": "Service Time", | |
"description": "Service time of the bundled addresses." | |
}, | |
"time_window_start": { | |
"type": "integer", | |
"title": "Time Window Start", | |
"description": "Time window start of the bundled addresses." | |
}, | |
"time_window_end": { | |
"type": "integer", | |
"title": "Time Window End", | |
"description": "Time window end of the bundled addresses." | |
}, | |
"custom_data": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
}, | |
"title": "Custom Data", | |
"description": "Custom data" | |
}, | |
"addresses_id": { | |
"type": "array", | |
"items": { | |
"type": "integer" | |
}, | |
"title": "Addresses IDs", | |
"description": "Array of the IDs of the bundeld addresses." | |
} | |
} | |
}, | |
"order_inventory": { | |
"type": "array", | |
"items": { | |
"type": "object", | |
"properties": { | |
"inventory_id": { | |
"type": "integer", | |
"title": "Inventory ID", | |
"description": "Unique inventory ID" | |
}, | |
"order_id": { | |
"type": "integer", | |
"title": "Order ID", | |
"description": "Unique order ID" | |
}, | |
"name": { | |
"type": "string", | |
"title": "Name", | |
"description": "Order inventory name" | |
}, | |
"quantity": { | |
"type": "integer", | |
"title": "Quantity", | |
"description": "An order inventory quantity" | |
}, | |
"total_weight": { | |
"type": "number", | |
"title": "Total Weight", | |
"description": "Total weight of the inventory" | |
}, | |
"total_volume": { | |
"type": "number", | |
"title": "Total Volume", | |
"description": "Total volume of the inventory" | |
}, | |
"total_cost": { | |
"type": "number", | |
"title": "Total Cost", | |
"description": "Total cost of the inventory" | |
}, | |
"total_price": { | |
"type": "number", | |
"title": "Total Price", | |
"description": "Total price of the inventory" | |
}, | |
"created_at": { | |
"type": "string", | |
"title": "Created At", | |
"description": "When the inventory created" | |
}, | |
"updated_at": { | |
"type": "string", | |
"title": "Updated At", | |
"description": "When the inventory updated" | |
} | |
} | |
} | |
}, | |
"path_to_next": { | |
"type": "array", | |
"items": { | |
"type": "object", | |
"properties": { | |
"lat": { | |
"type": "number", | |
"title": "Latitude", | |
"description": "Latitude", | |
"minimum": -90, | |
"maximum": 90 | |
}, | |
"lng": { | |
"type": "number", | |
"title": "Longitude", | |
"description": "Longitude", | |
"minimum": -180, | |
"maximum": 180 | |
} | |
} | |
} | |
}, | |
"wait_time_to_next_destination": { | |
"type": "integer", | |
"title": "Wait time to next destination", | |
"description": "Wait time to next destination" | |
}, | |
"manifest": { | |
"type": "object", | |
"properties": { | |
"running_service_time": { | |
"type": "integer", | |
"title": "Running Service Time", | |
"description": "How much time is to be spent on service from the start in seconds" | |
}, | |
"running_travel_time": { | |
"type": "integer", | |
"title": "Running Travel Time", | |
"description": "How much time is spent driving from the start in seconds" | |
}, | |
"running_wait_time": { | |
"type": "integer", | |
"title": "Running Wait Time", | |
"description": "Running Wait Time" | |
}, | |
"running_distance": { | |
"type": "number", | |
"title": "Running Distance", | |
"description": "Distance traversed before reaching this address" | |
}, | |
"udu_running_distance": { | |
"type": "number", | |
"title": "UDU Running Distance", | |
"description": "UDU distance traversed before reaching this address" | |
}, | |
"fuel_from_start": { | |
"type": "number", | |
"title": "Fuel From Start", | |
"description": "Fuel From Start" | |
}, | |
"fuel_cost_from_start": { | |
"type": "number", | |
"title": "Fuel Cost From Start", | |
"description": "Fuel Cost From Start" | |
}, | |
"projected_arrival_time_ts": { | |
"type": "integer", | |
"title": "Projected Arrival Time ts", | |
"description": "Projected arrival time UTC unixtime" | |
}, | |
"projected_departure_time_ts": { | |
"type": "integer", | |
"title": "Projected Departure Time ts", | |
"description": "Estimated departure time UTC unixtime" | |
}, | |
"actual_arrival_time_ts": { | |
"type": ["integer", "null"], | |
"title": "Actual Arrival Time ts", | |
"description": "Time when the address was marked as visited UTC unixtime. This is actually equal to timestamp_last_visited most of the time." | |
}, | |
"actual_departure_time_ts": { | |
"type": ["integer", "null"], | |
"title": "Actual Departure Time ts", | |
"description": "Time when the address was mared as departed UTC. This is actually equal to timestamp_last_departed most of the time." | |
}, | |
"estimated_arrival_time_ts": { | |
"type": "integer", | |
"title": "Estimated Arrival Time ts", | |
"description": "Estimated arrival time based on the current route progress, i.e. based on the last known actual_arrival_time" | |
}, | |
"estimated_departure_time_ts": { | |
"type": "integer", | |
"title": "Estimated Departure Time ts", | |
"description": "Estimated departure time based on the current route progress" | |
}, | |
"scheduled_arrival_time_ts": { | |
"type": "integer", | |
"title": "Scheduled Arrival Time ts", | |
"description": "Scheduled arrival time of a vehicle to this destination" | |
}, | |
"scheduled_departure_time_ts": { | |
"type": "integer", | |
"title": "Scheduled Departure Time ts", | |
"description": "Scheduled departure time of a vehicle from this destination" | |
}, | |
"time_impact": { | |
"type": ["integer", "null"], | |
"title": "Time Impact", | |
"description": "This is the difference between the originally projected arrival time and Actual Arrival Time" | |
} | |
}, | |
"description": "The manifest contains values derived from other values", | |
"title": "Manifest" | |
} | |
} | |
} |