LocationAPI.json

{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs013-location-api"
    },
    "title": "ETSI GS MEC 013 - Location API",
    "version": "3.1.1",
    "description": "The ETSI MEC ISG MEC013 Location API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    }
  },
  "externalDocs": {
    "description": "ETSI MEC013 V3.1.1 Location API",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/03.01.01_60/gs_mec013v030101p.pdf"
  },
  "servers": [
    {
      "url": "https://localhost/location/v2"
    }
  ],
  "tags": [
    {
      "name": "location"
    }
  ],
  "paths": {
    "/queries/distance": {
      "get": {
        "tags": ["location"],
        "summary": "Query information about distance from a user to a location or between two users",
        "description": "The GET method is used to query information about distance from a user to a location or between two users.",
        "operationId": "distanceGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.Address"
          },
          {
            "$ref": "#/components/parameters/Query.Location"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the list of distance information is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "terminalDistance": {
                      "$ref": "#/components/schemas/TerminalDistance"
                    }
                  }
                }
              }
            }
          },
          "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": "queries"
      }
    },
    "/queries/users": {
      "get": {
        "tags": ["location"],
        "summary": "Query location information about a specific UE or a group of Ues",
        "description": "The GET method is used to query location information about a specific UE or a group of Ues.",
        "operationId": "usersGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.ZoneId"
          },
          {
            "$ref": "#/components/parameters/Query.AccessPointId"
          },
          {
            "$ref": "#/components/parameters/Query.Address_3"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the list of user location information is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "userList": {
                      "$ref": "#/components/schemas/UserList"
                    }
                  }
                }
              }
            }
          },
          "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": "queries"
      }
    },
    "/queries/zones": {
      "get": {
        "tags": ["location"],
        "summary": "Query the information about one or more specific zones or a list of zones.",
        "description": "The GET method is used to query the information about one or more specific zones or a list of zones.",
        "operationId": "zonesGET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.ZoneId"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the list of zone information is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "zoneList": {
                      "$ref": "#/components/schemas/ZoneList"
                    }
                  }
                }
              }
            }
          },
          "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": "queries"
      }
    },
    "/queries/zones/{zoneId}": {
      "get": {
        "tags": ["location"],
        "summary": "Query information about a specific zone",
        "description": "The GET method is used to query the information about a specific zone.",
        "operationId": "zoneGetById",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.ZoneId"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the zone information is returned.",
            "content": {