LocationAPI.json 156 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "delete": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Cancel a subscription",
        "description": "Method to delete a subscription.",
        "operationId": "userTrackingSubDELETE",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/zonalTraffic": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieves all active subscriptions to zonal traffic notifications",
        "description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.",
        "operationId": "zonalTrafficSubListGET",
        "responses": {
          "200": {
            "description": "Response to retrieve zonal traffic subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscriptionList"
                  ],
                  "properties": {
                    "notificationSubscriptionList": {
                      "$ref": "#/components/schemas/NotificationSubscriptionList"
                    }
                  },
                  "examples": [
                    {
                      "notificationSubscriptionList": {
                        "zonalTrafficSubscription": [
                          {
                            "clientCorrelator": "0123",
                            "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription123",
                            "callbackReference": {
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "zoneId": "zone01",
                            "userEventCriteria": [
                              "Transferring"
                            ]
                          {
                            "clientCorrelator": "0124",
                            "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124",
                            "callbackReference": {
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "zoneId": "zone02",
                            "userEventCriteria": [
                              "Transferring"
                            ]
                          }
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic"
                      }
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Creates a subscription for zonal traffic notification",
        "description": "Creates a subscription to the Location Service for zonal traffic change notification.",
        "operationId": "zonalTrafficSubPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "zonalTrafficSubscription": {
                    "$ref": "#/components/schemas/ZonalTrafficSubscription"
                  }
                },
                "examples": [
                  {
                    "zonalTrafficSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "zoneId": "zone01",
                      "userEventCriteria": [
                        "Transferring"
                      ]
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful subscription",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "zonalTrafficSubscription": {
                      "$ref": "#/components/schemas/ZonalTrafficSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zonalTrafficSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
                      }
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/zonalTrafficSubscription.callbackReference.notifyURL}": {
              "post": {
Michel Roy's avatar
Michel Roy committed
                "summary": "Callback POST used to send a notification",
                "description": "Notification from Location service, content based on subscription type",
                "operationId": "zonalTrafficNotificationPOST",
Michel Roy's avatar
Michel Roy committed
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "zonalPresenceNotification": {
                            "$ref": "#/components/schemas/ZonalPresenceNotification"
                          }
                        },
                        "examples": [
                          {
                            "zonalPresenceNotification": {
                              "clientCorrelator": "0123",
                              "zoneId": "zone01",
                              "address": "acr:10.0.0.1",
                              "userEventType": "Transferring",
                              "currentAccessPointId": "ap2",
                              "previousAccessPointId": "ap1",
                              "timestamp": {
                                "seconds": 1483231138,
                                "nanoseconds": 0
                              },
                              "link": {
                                "rel": "ZonalTrafficSubscription",
                                "href": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
                              }
Michel Roy's avatar
Michel Roy committed
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/zonalTraffic/{subscriptionId}": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieve subscription information",
        "description": "Get subscription information.",
Michel Roy's avatar
Michel Roy committed
        "operationId": "zonalTrafficSubGET",
Michel Roy's avatar
Michel Roy committed
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "zonalTrafficSubscription"
                  ],
                  "properties": {
                    "zonalTrafficSubscription": {
                      "$ref": "#/components/schemas/ZonalTrafficSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zonalTrafficSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
                      }
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "put": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Updates a subscription information",
        "description": "Updates a subscription.",
        "operationId": "zonalTrafficSubPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "zonalTrafficSubscription": {
                    "$ref": "#/components/schemas/ZonalTrafficSubscription"
                  }
                },
                "examples": [
                  {
                    "zonalTrafficSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "zoneId": "zone01",
                      "userEventCriteria": [
                        "Transferring"
                      ],
                      "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "zonalTrafficSubscription": {
                      "$ref": "#/components/schemas/ZonalTrafficSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zonalTrafficSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123"
                      }
                    }
                  ]
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "412": {
            "$ref": "#/components/responses/412"
          },
          "422": {
            "$ref": "#/components/responses/422"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "delete": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Cancel a subscription",
        "description": "Method to delete a subscription.",
        "operationId": "zonalTrafficSubDELETE",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/zoneStatus": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieves all active subscriptions to zone status notifications",
        "description": "This operation is used for retrieving all active subscriptions to zone status change notifications.",
        "operationId": "zoneStatusSubListGET",
        "responses": {
          "200": {
            "description": "Response to retrieve zone status subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscriptionList"
                  ],
                  "properties": {
                    "notificationSubscriptionList": {
                      "$ref": "#/components/schemas/NotificationSubscriptionList"
                    }
                  },
                  "examples": [
                    {
                      "notificationSubscriptionList": {
                        "zoneStatusSubscription": [
                          {
                            "clientCorrelator": "0123",
                            "resourceURL": "http://example.com/exampleAPI/location/v2/subscriptions/zoneStatus/subscription123",
                            "callbackReference": {
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "zoneId": "zone01",
                            "numberOfUsersZoneThreshold": 500,
                            "operationStatus": [
                              "Serviceable"
                            ]
                          }
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus"
                      }
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Creates a subscription for zone status notification",
        "description": "Creates a subscription to the Location Service for zone status change notification.",
        "operationId": "zoneStatusSubPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "zoneStatusSubscription": {
                    "$ref": "#/components/schemas/ZoneStatusSubscription"
                  }
                },
                "examples": [
                  {
                    "zoneStatusSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "zoneId": "zone01",
                      "numberOfUsersZoneThreshold": 500,
                      "operationStatus": [
                        "Serviceable"
                      ]
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful subscription",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "zoneStatusSubscription": {
                      "$ref": "#/components/schemas/ZoneStatusSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zoneStatusSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "numberOfUsersZoneThreshold": 500,
                        "operationStatus": [
                          "Serviceable"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
                      }
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "callbacks": {
          "notification": {
            "{$request.body#/zoneStatusSubscription.callbackReference.notifyURL}": {
              "post": {
Michel Roy's avatar
Michel Roy committed
                "summary": "Callback POST used to send a notification",
                "description": "Notification from Location service, content based on subscription type",
                "operationId": "zoneStatusNotificationPOST",
Michel Roy's avatar
Michel Roy committed
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "zoneStatusNotification": {
                            "$ref": "#/components/schemas/ZoneStatusNotification"
                          }
                        },
                        "examples": [
                          {
                            "zoneStatusNotification": {
                              "clientCorrelator": "0123",
                              "zoneId": "zone01",
                              "accessPointId": "poa1",
                              "operationStatus": "Serviceable",
                              "numberOfUsersInZone": "20",
                              "numberOfUsersInAP": "12",
                              "timestamp": {
                                "seconds": 1483231138,
                                "nanoseconds": 0
                              },
                              "link": {
                                "rel": "ZoneStatusSubscription",
                                "href": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
                              }
Michel Roy's avatar
Michel Roy committed
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/zoneStatus/{subscriptionId}": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieve subscription information",
        "description": "Get subscription information.",
        "operationId": "zoneStatusSubGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "zoneStatusSubscription"
                  ],
                  "properties": {
                    "zoneStatusSubscription": {
                      "$ref": "#/components/schemas/ZoneStatusSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zoneStatusSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "numberOfUsersZoneThreshold": 500,
                        "operationStatus": [
                          "Serviceable"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
                      }
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "put": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Updates a subscription information",
        "description": "Updates a subscription.",
        "operationId": "zoneStatusSubPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "zoneStatusSubscription": {
                    "$ref": "#/components/schemas/ZoneStatusSubscription"
                  }
                },
                "examples": [
                  {
                    "zoneStatusSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "zoneId": "zone01",
                      "numberOfUsersZoneThreshold": 500,
                      "operationStatus": [
                        "Serviceable"
                      ],
                      "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful subscription to response to subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "zoneStatusSubscription": {
                      "$ref": "#/components/schemas/ZoneStatusSubscription"
                    }
                  },
                  "examples": [
                    {
                      "zoneStatusSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "zoneId": "zone01",
                        "numberOfUsersZoneThreshold": 500,
                        "operationStatus": [
                          "Serviceable"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/zoneStatus/sub123"
                      }
                    }
                  ]
Michel Roy's avatar
Michel Roy committed
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "412": {
            "$ref": "#/components/responses/412"
          },
          "422": {
            "$ref": "#/components/responses/422"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      },
      "delete": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Cancel a subscription",
        "description": "Method to delete a subscription.",
        "operationId": "zoneStatusSubDELETE",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "204": {
            "$ref": "#/components/responses/204"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    }
  },
  "components": {
    "responses": {
      "200": {
        "description": "OK"
      },
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "406": {
        "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "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",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "414": {
        "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "415": {
        "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "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.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests : used when a rate limiter has triggered.",
        "content": {
Michel Roy's avatar
Michel Roy committed
          "application/problem+json": {
Michel Roy's avatar
Michel Roy committed
            "schema": {
Michel Roy's avatar
Michel Roy committed
              "$ref": "#/components/schemas/ProblemDetails"
Michel Roy's avatar
Michel Roy committed
            }
          }
        }
      }
    },
    "parameters": {
      "Path.AccessPointId": {
        "name": "accessPointId",
        "in": "path",
        "description": "Identifier of access Point",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "AccessPointId"
      },
      "Path.SubscrId": {
        "name": "subscriptionId",
        "in": "path",
        "description": "Subscription Identifier, specifically the \"self\" returned in the subscription request",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uri"
        },
        "x-exportParamName": "SubscriptionId"
      },
      "Path.ZoneId": {
        "name": "zoneId",
        "in": "path",
        "description": "Indentifier of zone",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-exportParamName": "ZoneId"
      },
      "Query.AccessPointId": {
        "name": "accessPointId",
        "in": "query",
        "description": "Identifier of access point",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "x-exportParamName": "AccessPointId"
      },
      "Query.Address": {
        "name": "address",
        "in": "query",
        "description": "address of users (e.g. \"sip\" URI, \"tel\" URI, \"acr\" URI)",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"