Members_authenticate_response.dtd

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"id": "https://github.com/route4me/route4me-json-schemas/blob/master/Members_authenticate_response.dtd",
	"title": "Members Authenticate Response",
	"type": "object",
	"description": "For members authentication. url: https://www.route4me.com/actions/authenticate.php",
	"properties": {
		"status": {
			"type": "boolean",
			"title": "Status",
			"descrption": "True, if authentication process was finished successfuly."
		},
		"geocoding_service": {
			"type": "string",
			"title": "Geocoding service",
			"description": "Geocoding service"
		},
		"session_id": {
			"type": "integer",
			"title": "Session ID",
			"description": "Session ID"
		},
		"session_guid": {
			"type": "string",
			"title": "Session guid",
			"description": "Session guid"
		},
		"member_id": {
			"type": "integer",
			"title": "Member ID",
			"description": "Member ID"
		},
		"api_key": {
			"type": "string",
			"title": "API key",
			"description": "API key of an user"
		},
		"tracking_ttl": {
			"type": "integer",
			"title": "Tracking TTL",
			"description": "Tracking TTL"
		},
		"update_channel_name": {
			"type": "string",
			"title": "Update Channel Name",
			"description": "Update channel name"
		},
		"geofence_polygon_shape ": {
			"enum": [
				"circle",
				"poly",
				"rect"
			],
			"title": "Geofence polygon shape",
			"descrption": "Geofence polygon shape. ENUM(circle, poly rect)."
		},
		"geofence_polygon_size": {
			"type": "integer",
			"title": "Geofence polygon size",
			"description": "Geofence polygon size"
		},
		"geofence_time_onsite_trigger_secs": {
			"type": "integer",
			"title": "Geofence time onsite trigger secs",
			"description": "Geofence time onsite trigger in seconds."
		},
		"geofence_minimum_trigger_speed": {
			"type": "integer",
			"title": "Geofence minimum trigger speed",
			"description": "Geofence minimum trigger speed."
		},
		"is_subscription_past_due": {
			"type": "boolean",
			"title": "Is subscription past due",
			"descrption": "If true, subscription is past due."
		},
		"visited_departed_enabled": {
			"type": "string",
			"title": "Visited departed enabled",
			"description": "if true, triggering of the visited and departed activities is enabled."
		},
		"long_press_enabled": {
			"type": "string",
			"title": "Long press enabled",
			"description": "if true, long press is enabled."
		},
		"account_type_id": {
			"type": "string",
			"title": "Account type ID",
			"description": "The account type ID"
		},
		"account_type_alias": {
			"type": "string",
			"title": "Account type alias",
			"description": "Account type alias."
		},
		"member_type": {
			"type": "string",
			"enum": [
				"PRIMARY_ACCOUNT",
				"SUB_ACCOUNT_ADMIN",
				"SUB_ACCOUNT_REGIONAL_MANAGER",
				"SUB_ACCOUNT_DISPATCHER",
				"SUB_ACCOUNT_PLANNER",
				"SUB_ACCOUNT_DRIVER",
				"SUB_ACCOUNT_ANALYST",
				"SUB_ACCOUNT_VENDOR",
				"SUB_ACCOUNT_CUSTOMER_SERVICE"
			],
			"title": "Member type",
			"description": "A type of the member"
		},
		"max_stops_per_route": {
			"type": "string",
			"title": "Max stops per route",
			"description": "Maximum stops per route."
		},
		"max_routes": {
			"type": "string",
			"title": "Max routes",
			"description": "Maximum number of the routes."
		},
		"routes_planned": {
			"type": "integer",
			"title": "Routes planned",
			"description": "Number of the planned routes by an user."
		},
		"preferred_units ": {
			"enum": [
				"KM",
				"MI"
			],
			"title": "Preferred units",
			"descrption": "Preferred units. Enum(km,mi)."
		},
		"preferred_language ": {
			"enum": [
				"en",
				"fr"
			],
			"title": "Preferred language",
			"descrption": "Preferred language. Enum(en,fr)"
		},
		"HIDE_ROUTED_ADDRESSES": {
			"type": "string",
			"title": "Hide Routed Addresses",
			"description": "If true, routed addresses will be hidden."
		},
		"HIDE_VISITED_ADDRESSES": {
			"type": "string",
			"title": "Hide Visited Addresses",
			"description": "If true, visited addresses will be hidden."
		},
		"HIDE_NONFUTURE_ROUTES": {
			"type": "string",
			"title": "Hide Nonfuture Addresses",
			"description": "If equal to true, nonfuture addresses will be hidden."
		},
		"READONLY_USER": {
			"type": "string",
			"title": "Readonly User",
			"description": "If equal to true, user can only read data."
		},
		"auto_logout_ts": {
			"type": "integer",
			"title": "Auto logout TS",
			"description": "Time in seconds. If a user is inactive during this period, he will be logout."
		},
		"last_known_member_payment_device": {
			"type": "string",
			"title": "Last Known Member Payment Device",
			"description": "Last known member payment device (e.g. 'web')"
		},
		"account_expires_timestamp": {
			"type": "integer",
			"title": "Account expires timestamp",
			"description": "Account expire date"
		},
		"account_past_due": {
			"type": "boolean",
			"title": "Account Past Due",
			"descrption": "Account past due"
		},
		"licensed_modules": {
			"type": "array",
			"items": {
				"type": "string",
				"description": "Licensed module (e.g. 'MODULE__ROUTE_EDITOR_CUSTOM_DATA_EDITING',  'MODULE__VOICE_NAVIGATION:TRUE', 'MODULE__VOICE_NAVIGATION')"
			},
			"title": "Licensed Modules",
			"description": "Licensed modules"
		},
		"last_active_timestamp": {
			"type": "integer",
			"title": "Last Active Timestamp",
			"description": "Last active timestamp"
		}
	}
}