DataObjectRoute.dtd

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"id": "https://github.com/route4me/route4me-json-schemas/blob/master/DataObjectRoute.dtd",
	"title": "DataObjectRoute",
	"type": "object",
	"properties": {
		"route_id": {
			"type": [
				"string"
			],
			"title": "Route ID",
			"descrption": "Route unique identifier"
		},
		"member_id": {
			"type": [
				"string",
				"null"
			],
			"title": "Member ID",
			"descrption": "User ID who is assigned to the route"
		},
		"member_email": {
			"type": [
				"string",
				"null"
			],
			"title": "Member Email",
			"format": "email",
			"descrption": "User email"
		},
		"member_picture":{
			"type": [
				"string",
				"null"
			],
			"title": "Member Picture",
			"description": "URL to a member picture"
		},
		"member_tracking_subheadline" : {
			"type": [
				"string",
				"null"
			],
			"title": "Member Tracking Subheadline",
			"description": "Member tracking subheadline"
		},
		"approved_for_execution": {
			"type": "boolean",
			"title": "Approved For Execution",
			"description": "The route approved for execution"
		},
		"vehicle_alias": {
			"type": [
				"string",
				"null"
			],
			"title": "Vehicle Alias",
			"descrption": "Name of vehicle_id"
		},
		"driver_alias": {
			"type": [
				"string",
				"null"
			],
			"title": "Driver Alias",
			"descrption": "Name of driver_id"
		},
		"route_cost": {
			"type": [
				"number",
				"null"
			],
			"title": "Route Cost",
			"descrption": "Route cost"
		},
		"route_revenue": {
			"type": [
				"number",
				"null"
			],
			"title": "Route Revenue",
			"descrption": "Route revenue"
		},
		"net_revenue_per_distance_unit": {
			"type": [
				"number",
				"null"
			],
			"title": "Net Revenue per Distance Unit",
			"descrption": "equal to (Revenue - cost) / distance units"
		},
		"created_timestamp": {
			"type": [
				"integer",
				"null"
			],
			"title": "Created Timestamp",
			"descrption": "When was the route created"
		},
		"mpg": {
			"type": [
				"string",
				"null"
			],
			"title": "Miles per Gallon",
			"descrption": "Miles per gallon (used to compute fuel consumption)"
		},
		"trip_distance": {
			"type": [
				"number",
				"null"
			],
			"title": "Trip Distance",
			"descrption": "Route length (the unit is given by distance_unit)"
		},
		"gas_price": {
			"type": [
				"number",
				"null"
			],
			"title": "Gas Price",
			"descrption": "Price of gas (used to compute route costs)"
		},
		"route_duration_sec": {
			"type": [
				"integer",
				"null"
			],
			"title": "Route Duration (sec)",
			"descrption": "Estimated drive time of route (Seconds)"
		}
	},
	"required": [
		"route_id",
		"member_id"
	]
}