WlanInformationApi.json

                        "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123"
                      }
                    },
                    "expiryDeadline": {
                      "seconds": 1977836800,
                      "nanoSeconds": 0
                    },
                    "apId": {
                      "bssid": "005C0A0A0A0A",
                      "ssid": [
                        "myNetworkSsid"
                      ],
                      "ipAddress": [
                        "10.10.100.1"
                      ]
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful subscription modification",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/AssocStaSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/StaDataRateSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/MeasurementReportSubscription"
                    }
                  ],
                  "examples": [
                    {
                      "_links": {
                        "self": {
                          "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/wai/some-id",
                      "apId": {
                        "bssid": "005C0A0A0A0A",
                        "ssid": [
                          "myNetworkSsid"
                        ],
                        "ipAddress": [
                          "10.10.100.1"
                        ]
                      }
                    }
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "example-sub-type": {
                    "value": {
                      "subscriptionType": "AssocStaSubscription",
                      "_links": {
                        "self": {
                          "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123"
                        }
                      },
                      "callbackReference": "http://my.callback.com/wai/some-id",
                      "apId": {
                        "bssid": "005C0A0A0A0A",
                        "ssid": [
                          "myNetworkSsid"
                        ],
                        "ipAddress": [
                          "10.10.100.1"
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "examples": {
                  "application/problem+json": {
                    "value": {
                      "type": "https://meAppServer.example.com/wai/v2/probs/too-many targets",
                      "title": "Too many targets",
                      "status": 422,
                      "detail": "The target area for the request is considered too large",
                      "instance": "/meAppClient.example.com/77777/msgs/abc"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": [
          "wai"
        ],
        "summary": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "subscriptionsDELETE",
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Subscription Id, specifically the \"self\" returned in the subscription request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/measurements": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Queries information on measurements configuration",
        "description": "Queries information on measurements configuration",
        "operationId": "measurementLinkList_measurementsGET",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Response body contains the list of links to requestors measurement configurations.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfigLinkList"
                },
                "examples": {
                  "example-measurement": {
                    "value": {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/measurements"
                        }
                      },
                      "measurementConfig": [
                        {
                          "href": "http://meAppServer.example.com/wai/v2/measurements/meas123",
                          "measurementId": "myId1"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "post": {
        "tags": [
          "wai"
        ],
        "summary": "Creates a new measurement configuration",
        "description": "Creates a new measurement configuration",
        "operationId": "measurementsPOST",
        "parameters": [],
        "requestBody": {
          "description": "Measurement configuration information",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MeasurementConfig"
              },
              "examples": {
                "example-body": {
                  "value": {
                    "staId": [
                      {
                        "macId": "005C01111111",
                        "ssid": [
                          "myNetworkSsid",
                          "myOtherNetworkSsid"
                        ]
                      }
                    ],
                    "measurementId": "myId1",
                    "measurementInfo": {}
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Successful measurement configuration response",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfig"
                },
                "examples": {
                  "example-response": {
                    "value": {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
                        }
                      },
                      "staId": [
                        {
                          "macId": "005C01111111",
                          "ssid": [
                            "myNetworkSsid",
                            "myOtherNetworkSsid"
                          ]
                        }
                      ],
                      "measurementId": "myId1",
                      "measurementInfo": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "415": {
            "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "examples": {
                  "application/problem+json": {
                    "value": {
                      "type": "https://meAppServer.example.com/wai/v2/probs/too-many targets",
                      "title": "Too many targets",
                      "status": 422,
                      "detail": "The target area for the request is considered too large",
                      "instance": "/meAppClient.example.com/77777/msgs/abc"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
    "/measurements/{measurementConfigId}": {
      "get": {
        "tags": [
          "wai"
        ],
        "summary": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "description": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "measurementsGET",
        "parameters": [
          {
            "name": "measurementConfigId",
            "in": "path",
            "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Measurement configuration information",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfig"
                },
                "examples": {
                  "response-example": {
                    "value": {
                      "_links": {
                        "self": {
                          "href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
                        }
                      },
                      "staId": [
                        {
                          "macId": "005C01111111",
                          "ssid": [
                            "myNetworkSsid",
                            "myOtherNetworkSsid"
                          ]
                        }
                      ],
                      "measurementId": "myId1",
                      "measurementInfo": {}
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "put": {
        "tags": [
          "wai"
        ],
        "summary": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "description": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "measurementsPUT",
        "parameters": [
          {
            "name": "measurementConfigId",
            "in": "path",
            "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Measurement configuration to be modified",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MeasurementConfig"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful measurement configuration modification",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeasurementConfig"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                },
                "examples": {
                  "application/problem+json": {
                    "value": {
                      "type": "https://meAppServer.example.com/wai/v2/probs/too-many targets",
                      "title": "Too many targets",
                      "status": 422,
                      "detail": "The target area for the request is considered too large",
                      "instance": "/meAppClient.example.com/77777/msgs/abc"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": [
          "wai"
        ],
        "summary": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "description": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
        "operationId": "measurementsDELETE",
        "parameters": [
          {
            "name": "measurementConfigId",
            "in": "path",
            "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    }
  },
  "components": {
    "schemas": {
      "ApAssociated": {
        "title": "ApAssociated",
        "required": [
          "bssid"
        ],
        "type": "object",
        "properties": {
          "assocId": {
            "type": "string",
            "description": "Unique number which identifies a particular association between the station and Access Point."
          },
          "bssid": {
            "type": "string",
            "description": "Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address."
          },
          "ipAddress": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "IPv4 or IPv6 address allocated for the Access Point."
          },
          "ssid": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Service Set Identifier to identify logical networks."
          }
        }
      },
      "ApIdentity": {
        "title": "ApIdentity",
        "required": [
          "bssid"
        ],
        "type": "object",
        "properties": {
          "bssid": {
            "type": "string",
            "description": "Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address."
          },
          "ipAddress": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "IPv4 or IPv6 address allocated for the Access Point."
          },
          "ssid": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point."
          }
        }
      },
      "ApInfo": {
        "title": "ApInfo",
        "required": [
          "apId"
        ],
        "type": "object",
        "properties": {
          "apId": {
            "$ref": "#/components/schemas/ApIdentity"
          },
          "apLocation": {
            "$ref": "#/components/schemas/ApLocation"
          },
          "bssLoad": {
            "$ref": "#/components/schemas/BssLoad"
          },
          "channel": {
            "type": "integer",
            "description": "Channel configured for the Access Point.",
            "contentEncoding": "int32"
          },
          "extBssLoad": {
            "$ref": "#/components/schemas/ExtBssLoad"
          },
          "oBssLoad": {
            "$ref": "#/components/schemas/OBssLoad"
          },
          "timeStamp": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "wanMetrics": {
            "$ref": "#/components/schemas/WanMetrics"
          },
          "wlanCap": {
            "$ref": "#/components/schemas/WlanCapabilities"
          }
        }
      },
      "ApLocation": {
        "title": "ApLocation",
        "type": "object",
        "properties": {
          "civicLocation": {
            "$ref": "#/components/schemas/CivicLocation"
          },
          "geolocation": {
            "$ref": "#/components/schemas/GeoLocation"
          }
        }
      },
      "AssocStaNotification": {
        "title": "AssocStaNotification",
        "allOf": [
          {