Optimization_response.dtd

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"id": "https://github.com/route4me/route4me-json-schemas/blob/master/Optimization_response.dtd",
	"title": "Optimization Response",
	"type": "object",
	"properties": {
		"optimization_problem_id": {
			"type": "string",
			"title": "Optimization Problem ID",
			"descrption": "Optimization which generated this route"
		},
		"user_errors": {
			"type": "array",
			"title": "User Errors",
			"items": {"type": "string"},
			"descrption": "User Errors"
		},
		"optimization_errors": {
			"type": "array",
			"title": "Optimization Errors",
			"items": {"type": "string"},
			"descrption": "Optimization Errors"
		},
		"state": {
			"type": "integer",
			"enum": [0, 1, 2, 3, 4, 5, 6, 7 ],
			"title": "State",
			"description": "an optimization problem can be at one state at any given time (New = 0, Initial = 1, MatrixProcessing = 2, Optimizing = 3, Optimized = 4, Error = 5, ComputingDirections = 6, InQueue = 7)"
		},
		"created_timestamp": {
			"type": "integer",
			"title": "Created Timestamp",
			"descrption": "When the optimization problem was created"
		},
		"scheduled_for": {
			"type": "integer",
			"title": "Scheduled For",
			"descrption": "An Unix Timestamp the Optimization Problem was scheduled for."
		},
		"optimization_completed_timestamp": {
			"type": ["integer", "null"],
			"title": "Optimization Completed Timestamp",
			"descrption": "When the Optimization Problem was completed."
		},
		"parameters": {
			"type": "object",
			"title": "Route Parameters",
			"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/RouteParameters.dtd",
			"descrption": "Route Parameters"
		},
		"sent_to_background": {
			"type": "boolean",
			"title": "Sent to Background",
			"descrption": "If true it means the solution was not returned (it is being computed in the background)"
		},
		"addresses": {
			"type": "array",
			"title": "Route Addresses",
			"items": {"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/Address.dtd"},
			"descrption": "Route Addresses"
		},
		"routes": {
			"type": "array",
			"title": "Routes",
			"items": {"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/DataObjectRoute.dtd"},
			"descrption": "Routes"
		},
		"links": {
			"type": "array",
			"title": "Links",
			"items": {"$ref": "https://github.com/route4me/route4me-json-schemas/blob/master/Links.dtd"},
			"descrption": "Links to the GET operations for the optimization problem"
		}
	}
}