Skip to content
AccessPointList.schema.json 9.52 KiB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
{
	"accessPointList": {
		"description": "A type containing list of access points.",
		"properties": {
			"accessPoint": {
				"description": "Collection of the access point information list.",
				"items": {
					"description": "A type containing access point information.",
					"properties": {
						"accessPointId": {
							"description": "Identifier of access point.",
							"type": "string",
							"x-etsi-mec-cardinality": 1,
							"x-etsi-mec-origin-type": "string"
						},
						"connectionType": {
							"description": "The connection type for the access point",
							"enum": [
								"Femto",
								"LTE-femto",
								"Smallcell",
								"LTE-smallcell",
								"Wifi",
								"Pico",
								"Micro",
								"Macro",
								"Wimax",
								"Unknown"
							],
							"type": "string"
						},
						"interestRealm": {
							"description": "Interest realm of access point.",
							"type": "string",
							"x-etsi-mec-cardinality": "0..1",
							"x-etsi-mec-origin-type": "string"
						},
						"locationInfo": {
							"properties": {
								"accuracy": {
									"description": "Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"accuracyAltitude": {
									"description": "Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 3 or 4",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"accuracySemiMinor": {
									"description": "Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if \"shape\" equals 4, 5 or 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"altitude": {
									"description": "Location altitude relative to the WGS84 ellipsoid surface.",
									"format": "float",
									"type": "number",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "Float"
								},
								"confidence": {
									"description": "Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if \"shape\" equals 1, 4 or 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"includedAngle": {
									"description": "Present only if \"shape\" equals 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"innerRadius": {
									"description": "Present only if \"shape\" equals 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"latitude": {
									"description": "Location latitude, expressed in the range -90 to +90. Cardinality greater than one only if \"shape\" equals 7.",
									"items": {
										"format": "float",
										"type": "number"
									},
									"minItems": 1,
									"type": "array",
									"x-etsi-mec-cardinality": "1..N",
									"x-etsi-mec-origin-type": "Float"
								},
								"longitude": {
									"description": "Location longitude, expressed in the range -180 to +180. Cardinality greater than one only if \"shape\" equals 7.",
									"items": {
										"format": "float",
										"type": "number"
									},
									"minItems": 1,
									"type": "array",
									"x-etsi-mec-cardinality": "1..N",
									"x-etsi-mec-origin-type": "Float"
								},
								"offsetAngle": {
									"description": "Present only if \"shape\" equals 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"orientationMajorAxis": {
									"description": "Angle of orientation of the major axis, expressed in the range 0 to 180, as defined in [14]. Present only if \"shape\" equals 4 or 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"shape": {
									"description": "Shape information, as detailed in [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON",
									"type": "integer",
									"x-etsi-mec-cardinality": "1",
									"x-etsi-mec-origin-type": "Enum_inlined"
								},
								"timestamp": {
									"properties": {
										"nanoSeconds": {
											"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
											"format": "int32",
											"type": "integer",
											"x-etsi-mec-cardinality": "1",
											"x-etsi-mec-origin-type": "Uint32"
										},
										"seconds": {
											"description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
											"format": "int32",
											"type": "integer",
											"x-etsi-mec-cardinality": "1",
											"x-etsi-mec-origin-type": "Uint32"
										}
									},
									"required": [
										"seconds",
										"nanoSeconds"
									],
									"type": "object",
									"x-etsi-ref": "6.5.2"
								},
								"uncertaintyRadius": {
									"description": "Present only if \"shape\" equals 6",
									"type": "integer",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "UnsignedInt"
								},
								"velocity": {
									"description": "Structure with attributes relating to the target entitys velocity, as defined in [14].",
									"properties": {
										"bearing": {
											"description": "Bearing, expressed in the range 0 to 360, as defined in [14].",
											"type": "integer",
											"x-etsi-mec-cardinality": "1",
											"x-etsi-mec-origin-type": "UnsignedInt"
										},
										"horizontalSpeed": {
											"description": "Horizontal speed, expressed in km/h and defined in [14].",
											"type": "integer",
											"x-etsi-mec-cardinality": "1",
											"x-etsi-mec-origin-type": "UnsignedInt"
										},
										"uncertainty": {
											"description": "Horizontal uncertainty, as defined in [14]. Present only if \"velocityType\" equals 3 or 4",
											"type": "integer",
											"x-etsi-mec-cardinality": "0..1",
											"x-etsi-mec-origin-type": "UnsignedInt"
										},
										"velocityType": {
											"description": "Velocity information, as detailed in [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT",
											"type": "integer",
											"x-etsi-mec-cardinality": "1",
											"x-etsi-mec-origin-type": "Enum_inlined"
										},
										"verticalSpeed": {
											"description": "Vertical speed, expressed in km/h and defined in [14]. Present only if \"velocityType\" equals 2 or 4",
											"type": "integer",
											"x-etsi-mec-cardinality": "0..1",
											"x-etsi-mec-origin-type": "Int"
										},
										"verticalUncertainty": {
											"description": "Vertical uncertainty, as defined in [14]. Present only if \"velocityType\" equals 4",
											"type": "integer",
											"x-etsi-mec-cardinality": "0..1",
											"x-etsi-mec-origin-type": "UnsignedInt"
										}
									},
									"required": [
										"velocityType",
										"bearing",
										"horizontalSpeed"
									],
									"type": "object",
									"x-etsi-mec-cardinality": "0..1",
									"x-etsi-mec-origin-type": "Structure (inlined)"
								}
							},
							"required": [
								"latitude",
								"longitude",
								"shape"
							],
							"type": "object",
							"x-etsi-ref": "6.5.3"
						},
						"numberOfUsers": {
							"description": "Number of users currently on the access point.",
							"type": "integer",
							"x-etsi-mec-cardinality": 1,
							"x-etsi-mec-origin-type": "integer"
						},
						"operationStatus": {
							"enum": [
								"Serviceable",
								"Unserviceable",
								"Unknown"
							],
							"type": "string"
						},
						"resourceURL": {
							"description": "Self referring URL",
							"type": "string",
							"x-etsi-mec-cardinality": 1,
							"x-etsi-mec-origin-type": "anyURI"
						},
						"timezone": {
							"description": "Time zone of access point.",
							"type": "string",
							"x-etsi-mec-cardinality": "0..1",
							"x-etsi-mec-origin-type": "dateTimeStamp"
						}
					},
					"required": [
						"accessPointId",
						"connectionType",
						"operationStatus",
						"numberOfUsers",
						"resourceURL"
					],
					"type": "object"
				},
				"type": "array",
				"x-etsi-mec-cardinality": "0..N",
				"x-etsi-mec-origin-type": "AccessPointInfo"
			},
			"resourceURL": {
				"description": "Self referring URL",
				"type": "string",
				"x-etsi-mec-cardinality": 1,
				"x-etsi-mec-origin-type": "anyURI"
			},
			"zoneId": {
				"description": "Identifier of zone",
				"type": "string",
				"x-etsi-mec-cardinality": 1,
				"x-etsi-mec-origin-type": "string"
			}
		},
		"required": [
			"zoneId",
			"resourceURL"
		],
		"type": "object"
	}
}