GeolocationResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Geolocation",
    "version": "2019-02-15",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "copyright 2016-2017, 2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/GeolocationResURI" : {
      "get": {
        "description": "This Resource describes the properties associated with the current geolocation coordinate.\nGeolocation is a geolocation coordinate data.\nThe Property \"latitude\" is a device's current Latitude coordinate (degrees).\nThe Property \"longitude\" is a device's current Longitude coordinate (degrees).\nThe Property \"alt\" is a device's current distance (metres) above or below 'local' sea-level.\nThe Property \"accuracy\" is the accuracy level of the latitude and longitude coordinates (metres).\nThe Property \"altitudeAccuracy\" is the accuracy level of the altitude coordinates (metres).\nThe Property \"heading\" is a direction of travel of device (degree).\nThe Property \"speed\" is a device's current velocity (metres per second).",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "RETRIEVES the current geolocation coordinates.",
              "x-example":
                {
                  "rt": ["oic.r.sensor.geolocation"],
                  "if": ["oic.if.s", "oic.if.baseline"],
                  "latitude": 55.070859,
                  "longitude": -3.60512,
                  "alt": 12.07,
                  "accuracy": 65.0,
                  "altitudeAccuracy": 0.0,
                  "heading": 90.0,
                  "speed": 0.0
                },
              "schema": { "$ref": "#/definitions/Geolocation" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "Geolocation" : {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": ["oic.r.sensor.geolocation"],
            "maxLength": 64,
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "longitude": {
          "description": "The Device's Current Longitude coordinate (degrees).",
          "readOnly": true,
          "type": "number"
        },
        "heading": {
          "description": "The direction of travel of the Device (degree).",
          "maximum": 360,
          "minimum": 0,
          "readOnly": true,
          "type": "number"
        },
        "latitude": {
          "description": "The Device's Current Latitude coordinate (degrees).",
          "readOnly": true,
          "type": "number"
        },
        "altitudeAccuracy": {
          "description": "The accuracy level of the altitude coordinates (metres).",
          "minimum": 0,
          "readOnly": true,
          "type": "number"
        },
        "alt": {
          "description": "The current distance (metres) above or below 'local' sea-level.",
          "readOnly": true,
          "type": "number"
        },
        "accuracy": {
          "description": "The accuracy level of the latitude and longitude coordinates (metres).",
          "minimum": 0,
          "readOnly": true,
          "type": "number"
        },
        "speed": {
          "description": "The Device's current velocity (metres per second).",
          "minimum": 0,
          "readOnly": true,
          "type": "number"
        },
        "n": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
            "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["latitude", "longitude", "alt"]
    }
  }
}