LocationAPI.json 156 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/distance/{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": "distanceSubGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "distanceNotificationSubscription"
                  ],
                  "properties": {
                    "distanceNotificationSubscription": {
                      "$ref": "#/components/schemas/DistanceNotificationSubscription"
                    }
                  },
                  "examples": [
                    {
                      "distanceNotificationSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "callbackData": "1234",
                          "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                        },
                        "monitoredAddress": [
                          "acr:10.0.0.1",
                          "acr:10.0.0.2"
                        ],
                        "checkImmediate": true,
                        "criteria": "AllWithinDistance",
                        "distance": 100,
                        "frequency": 10,
                        "referenceAddress": "acr:10.0.0.3",
                        "trackingAccuracy": 10,
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123"
                      }
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": "distanceSubPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "distanceNotificationSubscription": {
                    "$ref": "#/components/schemas/DistanceNotificationSubscription"
                  }
                },
                "examples": [
                  {
                    "distanceNotificationSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "callbackData": "1234",
                        "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                      },
                      "monitoredAddress": [
                        "acr:10.0.0.1",
                        "acr:10.0.0.2"
                      ],
                      "checkImmediate": true,
                      "criteria": "AllWithinDistance",
                      "distance": 100,
                      "frequency": 10,
                      "referenceAddress": "acr:10.0.0.3",
                      "trackingAccuracy": 10,
                      "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123"
                    }
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": {
                    "distanceNotificationSubscription": {
                      "$ref": "#/components/schemas/DistanceNotificationSubscription"
                    }
                  },
                  "examples": [
                    {
                      "distanceNotificationSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "callbackData": "1234",
                          "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                        },
                        "monitoredAddress": [
                          "acr:10.0.0.1",
                          "acr:10.0.0.2"
                        ],
                        "checkImmediate": true,
                        "criteria": "AllWithinDistance",
                        "distance": 100,
                        "frequency": 10,
                        "referenceAddress": "acr:10.0.0.3",
                        "trackingAccuracy": 10,
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123"
                      }
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": "distanceSubDELETE",
        "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/periodic": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieves all active subscriptions to periodic notifications",
        "description": "This operation is used for retrieving all active subscriptions to periodic notifications.",
        "operationId": "periodicSubListGET",
        "responses": {
          "200": {
            "description": "Response to retrieve area subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscriptionList"
                  ],
                  "properties": {
                    "notificationSubscriptionList": {
                      "$ref": "#/components/schemas/NotificationSubscriptionList"
                    }
                  },
                  "examples": [
                    {
                      "notificationSubscriptionList": {
                        "periodicNotificationSubscription": [
                          {
                            "clientCorrelator": "0123",
                            "callbackReference": {
                              "callbackData": "1234",
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "address": "acr:10.0.0.1",
                            "frequency": 10,
                            "requestedAccuracy": 10,
                            "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123"
                          }
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic"
                      }
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Creates a subscription for periodic notification",
        "description": "Creates a subscription to the Location Service for a periodic notification.",
        "operationId": "periodicSubPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "periodicNotificationSubscription": {
                    "$ref": "#/components/schemas/PeriodicNotificationSubscription"
                  }
                },
                "examples": [
                  {
                    "periodicNotificationSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "callbackData": "1234",
                        "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                      },
                      "address": "acr:10.0.0.1",
                      "frequency": 10,
                      "requestedAccuracy": 10
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful subscription",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "periodicNotificationSubscription": {
                      "$ref": "#/components/schemas/PeriodicNotificationSubscription"
                    }
                  },
                  "examples": [
                    {
                      "periodicNotificationSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "callbackData": "1234",
                          "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                        },
                        "address": "acr:10.0.0.1",
                        "frequency": 10,
                        "requestedAccuracy": 10,
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123"
                      }
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#/periodicNotificationSubscription.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": "periodicNotificationPOST",
Michel Roy's avatar
Michel Roy committed
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "subscriptionNotification": {
                            "$ref": "#/components/schemas/SubscriptionNotification"
                          }
                        },
                        "examples": [
                          {
                            "subscriptionNotification": {
                              "isFinalNotification": "false,",
                              "link": {
                                "rel": "PeriodicNotificationSubscription",
                                "href": "http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123"
                              "terminalLocation": {
                                "address": "acr:10.0.0.1",
                                "currentLocation": {
                                  "accuracy": 100,
                                  "altitude": 1001,
                                  "latitude": -80.86302,
                                  "longitude": 41.277306,
                                  "timestamp": {
                                    "seconds": 1483231138,
                                    "nanoSeconds\"": 0
                                  }
                                },
                                "locationRetrievalStatus": "Retrieved"
                              }
Michel Roy's avatar
Michel Roy committed
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/periodic/{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": "periodicSubGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "periodicNotificationSubscription"
                  ],
                  "properties": {
                    "periodicNotificationSubscription": {
                      "$ref": "#/components/schemas/PeriodicNotificationSubscription"
                    }
                  },
                  "examples": [
                    {
                      "periodicNotificationSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "callbackData": "1234",
                          "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                        },
                        "address": "acr:10.0.0.1",
                        "frequency": 10,
                        "requestedAccuracy": 10,
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123"
                      }
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": "periodicSubPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "periodicNotificationSubscription": {
                    "$ref": "#/components/schemas/PeriodicNotificationSubscription"
                  }
                },
                "examples": [
                  {
                    "periodicNotificationSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "callbackData": "1234",
                        "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                      },
                      "address": "acr:10.0.0.1",
                      "frequency": 10,
                      "requestedAccuracy": 10,
                      "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123"
                    }
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": {
                    "periodicNotificationSubscription": {
                      "$ref": "#/components/schemas/PeriodicNotificationSubscription"
                    }
                  },
                  "examples": [
                    {
                      "periodicNotificationSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "callbackData": "1234",
                          "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                        },
                        "address": "acr:10.0.0.1",
                        "frequency": 10,
                        "requestedAccuracy": 10,
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123"
                      }
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": "periodicSubDELETE",
        "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/userTracking": {
      "get": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Retrieves all active subscriptions to user tracking notifications",
        "description": "This operation is used for retrieving all active subscriptions to user tracking notifications.",
        "operationId": "userTrackingSubListGET",
        "responses": {
          "200": {
            "description": "Response to retrieve user tracking subscriptions",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "notificationSubscriptionList"
                  ],
                  "properties": {
                    "notificationSubscriptionList": {
                      "$ref": "#/components/schemas/NotificationSubscriptionList"
                    }
                  },
                  "examples": [
                    {
                      "notificationSubscriptionList": {
                        "userTrackingSubscription": [
                          {
                            "clientCorrelator": "0123",
                            "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription123",
                            "callbackReference": {
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "address": "acr:192.0.2.1",
                            "userEventCriteria": [
                              "Transferring"
                            ]
                          {
                            "clientCorrelator": "0124",
                            "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124",
                            "callbackReference": {
                              "notifyURL": "http://clientApp.example.com/location_notifications/123456"
                            },
                            "address": "acr:192.0.2.2",
                            "userEventCriteria": [
                              "Transferring"
                            ]
                          }
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking"
                      }
Michel Roy's avatar
Michel Roy committed
          "location"
Michel Roy's avatar
Michel Roy committed
        ],
        "summary": "Creates a subscription for user tracking notification",
        "description": "Creates a subscription to the Location Service for user tracking change notification.",
        "operationId": "userTrackingSubPOST",
        "requestBody": {
          "description": "Subscription to be created",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userTrackingSubscription": {
                    "$ref": "#/components/schemas/UserTrackingSubscription"
                  }
                },
                "examples": [
                  {
                    "userTrackingSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "address": "acr:10.0.0.1",
                      "userEventCriteria": [
                        "Transferring"
                      ]
                    }
Michel Roy's avatar
Michel Roy committed
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful subscription",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "userTrackingSubscription": {
                      "$ref": "#/components/schemas/UserTrackingSubscription"
                    }
                  },
                  "examples": [
                    {
                      "userTrackingSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "address": "acr:10.0.0.1",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/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#/userTrackingSubscription.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": "userTrackingNotificationPOST",
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": "UserTrackingSubscription",
                                "href": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123"
                              }
Michel Roy's avatar
Michel Roy committed
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
          }
        },
        "x-swagger-router-controller": "subscriptions"
      }
    },
    "/subscriptions/userTracking/{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": "userTrackingSubGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.SubscrId"
          }
        ],
        "responses": {
          "200": {
            "description": "Subscription information regarding subscription notifications",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "userTrackingSubscription"
                  ],
                  "properties": {
                    "userTrackingSubscription": {
                      "$ref": "#/components/schemas/UserTrackingSubscription"
                    }
                  },
                  "examples": [
                    {
                      "userTrackingSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "address": "acr:10.0.0.1",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/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": "userTrackingSubPUT",
        "requestBody": {
          "description": "Subscription to be modified",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "userTrackingSubscription": {
                    "$ref": "#/components/schemas/UserTrackingSubscription"
                  }
                },
                "examples": [
                  {
                    "userTrackingSubscription": {
                      "clientCorrelator": "0123",
                      "callbackReference": {
                        "notifyURL": "http://my.callback.com/location_notifications/some-id"
                      },
                      "address": "acr:10.0.0.1",
                      "userEventCriteria": [
                        "Transferring"
                      ],
                      "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/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": {
                    "userTrackingSubscription": {
                      "$ref": "#/components/schemas/UserTrackingSubscription"
                    }
                  },
                  "examples": [
                    {
                      "userTrackingSubscription": {
                        "clientCorrelator": "0123",
                        "callbackReference": {
                          "notifyURL": "http://my.callback.com/location_notifications/some-id"
                        },
                        "address": "acr:10.0.0.1",
                        "userEventCriteria": [
                          "Transferring"
                        ],
                        "resourceURL": "http://meAppServer.example.com/location/v2/subscriptions/userTracking/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"
          }