Jump to

• Request
• Response

Update a Device Location with a New One

put

/iot/api/v2/devices/{device-id}/location

Fully replaces device location information. Resulting location must include at least the following fields: latitude, longitude

Request

Supported Media Types

• application/json

Path Parameters

• device-id: string
  ID of device to be retrieved from Cloud Service

Body ()

Root Schema : LocationImpl_create

Type: object

Show Source

• altitude(optional): integer
  Property description was not set
• empty: boolean
  Property description was not set
• geoLocationString: string
  Property description was not set
• latitude: integer
  Property description was not set
• latLonString: string
  Property description was not set
• longitude: integer
  Property description was not set
• origin: string
  One of [ASSIGNED, REPORTED, DERIVED].
• uncertainty(optional): integer
  Property description was not set

{
    "properties":{
        "altitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "empty":{
            "description":"Property description was not set",
            "type":"boolean"
        },
        "geoLocationString":{
            "description":"Property description was not set",
            "type":"string"
        },
        "latLonString":{
            "description":"Property description was not set",
            "type":"string"
        },
        "latitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "longitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "origin":{
            "description":"One of [ASSIGNED, REPORTED, DERIVED].",
            "type":"string"
        },
        "uncertainty":{
            "description":"Property description was not set",
            "type":"integer"
        }
    },
    "required":[
        "latLonString",
        "geoLocationString",
        "latitude",
        "longitude",
        "origin",
        "empty"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

200 Response

Successfully processed.

Body ()

Root Schema : LocationImpl_receive

Type: object

Show Source

• altitude: integer
  Property description was not set
• lastModified: integer
  Property description was not set
• lastModifiedAsDate: integer
  Property description was not set
• latitude: integer
  Property description was not set
• longitude: integer
  Property description was not set
• uncertainty: integer
  Property description was not set

{
    "properties":{
        "altitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "lastModified":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "lastModifiedAsDate":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "latitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "longitude":{
            "description":"Property description was not set",
            "type":"integer"
        },
        "uncertainty":{
            "description":"Property description was not set",
            "type":"integer"
        }
    },
    "required":[
        "lastModifiedAsDate",
        "latitude",
        "longitude",
        "altitude",
        "uncertainty",
        "lastModified"
    ],
    "type":"object"
}

406 Response

Request Not Acceptable. The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

415 Response

Unsupported Media Type. The request entity has a media type which the server or resource does not support.

Back to Top