"description":"A type containing list of access points.",
"type":"object",
"required":[
"zoneId",
"resourceURL"
],
"properties":{
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"example":"zone01"
},
"accessPoint":{
"description":"Collection of the access point information list.",
"type":"array",
"items":{
"description":"A type containing access point information.",
"type":"object",
"required":[
"accessPointId",
"connectionType",
"operationStatus",
"numberOfUsers",
"resourceURL"
],
"properties":{
"accessPointId":{
"description":"Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element",
"type":"string",
"example":"001010000000000000000000000000001"
},
"locationInfo":{
"description":"A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.",
"type":"object",
"required":[
"latitude",
"longitude",
"accuracy"
],
"properties":{
"latitude":{
"type":"number",
"format":"float",
"example":"80.123"
},
"longitude":{
"type":"number",
"format":"float",
"example":"70.123"
},
"altitude":{
"type":"number",
"format":"float",
"example":"10.0"
},
"accuracy":{
"type":"integer",
"format":"int32",
"example":"10"
}
}
},
"connectionType":{
"description":"The connection type for the access point",
"type":"string",
"enum":[
"Femto",
"LTE-femto",
"Smallcell",
"LTE-smallcell",
"Wifi",
"Pico",
"Micro",
"Macro",
"Wimax",
"Unknown"
],
"example":"Macro"
},
"operationStatus":{
"description":"The operation status of the access point",
"type":"string",
"enum":[
"Serviceable",
"Unserviceable",
"Unknown"
],
"example":"Serviceable"
},
"numberOfUsers":{
"description":"The number of users currently on the access point.",
"type":"integer",
"format":"uint32",
"example":"7"
},
"timezone":{
"description":"Time zone of access point",
"type":"string",
"format":"date-time",
"example":"2017-01-01T02:51:43Z"
},
"interestRealm":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"description":"A type containing list of access points.",
"type":"object",
"required":[
"zoneId",
"resourceURL"
],
"properties":{
"zoneId":{
"description":"Identifier of zone",
"type":"string",
"example":"zone01"
},
"accessPoint":{
"description":"Collection of the access point information list.",
"type":"array",
"items":{
"description":"A type containing access point information.",
"type":"object",
"required":[
"accessPointId",
"connectionType",
"operationStatus",
"numberOfUsers",
"resourceURL"
],
"properties":{
"accessPointId":{
"description":"Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity (28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3 digit MNC. The Cell Portion is an optional element",
"type":"string",
"example":"001010000000000000000000000000001"
},
"locationInfo":{
"description":"A type containing location information with latitude, longitude and altitude, in addition the accuracy of the information are provided.",
"type":"object",
"required":[
"latitude",
"longitude",
"accuracy"
],
"properties":{
"latitude":{
"type":"number",
"format":"float",
"example":"80.123"
},
"longitude":{
"type":"number",
"format":"float",
"example":"70.123"
},
"altitude":{
"type":"number",
"format":"float",
"example":"10.0"
},
"accuracy":{
"type":"integer",
"format":"int32",
"example":"10"
}
}
},
"connectionType":{
"description":"The connection type for the access point",
"type":"string",
"enum":[
"Femto",
"LTE-femto",
"Smallcell",
"LTE-smallcell",
"Wifi",
"Pico",
"Micro",
"Macro",
"Wimax",
"Unknown"
],
"example":"Macro"
},
"operationStatus":{
"description":"The operation status of the access point",
"type":"string",
"enum":[
"Serviceable",
"Unserviceable",
"Unknown"
],
"example":"Serviceable"
},
"numberOfUsers":{
"description":"The number of users currently on the access point.",
"type":"integer",
"format":"uint32",
"example":"7"
},
"timezone":{
"description":"Time zone of access point",
"type":"string",
"format":"date-time",
"example":"2017-01-01T02:51:43Z"
},
"interestRealm":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"description":"A type containing zonal traffic subscription",
"type":"object",
"required":[
"callbackReference",
"zoneId"
],
"properties":{
"clientCorrelator":{
"description":"Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.",
"description":"Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).",
"type":"array",
"items":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type":"string",
"example":"LA"
}
},
"userEventCriteria":{
"description":"List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type":"array",
"items":{
"description":"User event",
"type":"string",
"enum":[
"Entering",
"Leaving",
"Transferring"
],
"example":"Entering"
}
},
"duration":{
"description":"Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
"description":"A type containing zonal traffic subscription",
"type":"object",
"required":[
"callbackReference",
"zoneId"
],
"properties":{
"clientCorrelator":{
"description":"Uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription.",
"description":"Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).",
"type":"array",
"items":{
"description":"Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type":"string",
"example":"LA"
}
},
"userEventCriteria":{
"description":"List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.",
"type":"array",
"items":{
"description":"User event",
"type":"string",
"enum":[
"Entering",
"Leaving",
"Transferring"
],
"example":"Entering"
}
},
"duration":{
"description":"Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
