Return a Device by ID
get
/mobile/platform/location/devices/{id}
Retrieves the location device that matches the ID.
Permissions
You can access this operation as a social user, a virtual user, an anonymous user, or a mobile user. If you access this operation as a virtual user or a mobile user, then you must have the role that's associated with the mobile backend.
Request
Path Parameters
-
id: integer
The ID of the device to be returned. This ID must be an existing device ID.
Response
Supported Media Types
- application/json
200 Response
The location device was retrieved successfully.
Root Schema : Location Device
Type:
object
Title:
Location Device
The properties for a location device. The long format includes all properties. The short format applies to `POST /mobile/platform/location/devices` responses only.
Show Source
-
asset:
object Associated Asset
Title:
Associated Asset
The properties for an associated asset. This object doesn't include the `devices` property because the associated device is the containing object. -
attributes:
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the UI, as key/value pairs. -
beacon:
object Beacon
Title:
Beacon
Device's identifying information. -
createdBy:
string
User who added the device.
-
createdOn:
string
When the device was added.
-
description:
string
Device's description.
-
id:
number
Device's ID.
-
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy:
string
User who last modified the device.
-
modifiedOn:
string
When the device was last modified.
-
name:
string
User-defined name for the device.
-
place:
object Associated Place
Title:
Associated Place
The properties for an associated place. This object doesn't include the `devices` property because the associated device is the containing object.
Nested Schema : Associated Asset
Type:
object
Title:
Associated Asset
The properties for an associated asset. This object doesn't include the `devices` property because the associated device is the containing object.
Show Source
-
attributes:
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the UI, as key/value pairs. -
createdBy:
string
User who added the asset.
-
createdOn:
string
When the asset was added.
-
description:
string
Asset's description.
-
id:
number
Asset's ID.
-
label:
string
Asset's label.
-
lastKnownLocation:
object Last Known Location
Title:
Last Known Location
Last known location of the asset. -
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy:
string
User who last modified the asset.
-
modifiedOn:
string
When the asset was last modified.
-
name:
string
User-defined name for the asset.
Nested Schema : Attributes
Type:
object
Title:
Attributes
Additional Properties Allowed
Show Source
The attributes entered in the UI, as key/value pairs.
Show Source
Nested Schema : Beacon
Type:
object
Title:
Beacon
Device's identifying information.
Match One
Show Source
Nested Schema : Relationship links
Type:
array
Title:
Relationship links
Minimum Number of Items:
1
Unique Items Required:
Show Source
true
-
[0]:
object Link
Title:
Link
Nested Schema : Associated Place
Type:
object
Title:
Associated Place
The properties for an associated place. This object doesn't include the `devices` property because the associated device is the containing object.
Show Source
-
address:
object Place's Address
Title:
Place's Address
GPS address of the place. -
attributes:
object Attributes
Title:
Attributes
Additional Properties Allowed: additionalPropertiesThe attributes entered in the UI, as key/value pairs. -
createdBy:
string
User who added the place.
-
createdOn:
string
When the place was added.
-
description:
string
Place's description.
-
hasChildren:
boolean
Set to `true` if this place is a parent of other places.
-
id:
number
Place's ID.
-
label:
string
Place's label.
-
links:
array Relationship links
Title:
Relationship links
Minimum Number of Items:1
Unique Items Required:true
-
modifiedBy:
string
User who last modified the place.
-
modifiedOn:
string
When the place was last modified.
-
name:
string
User-defined name for the place.
-
parentPlace:
number
Place's parent place.
Nested Schema : Last Known Location
Type:
object
Title:
Last Known Location
Last known location of the asset.
Match One
Show Source
Nested Schema : gpsPoint
Type:
object
GPS point.
Show Source
-
latitude:
number
GPS point's latitude
-
longitude:
number
GPS point's longitude.
Nested Schema : iBeacon
Type:
object
iBeacon device.
Show Source
-
major:
string
Device's major version number.
-
minor:
string
Device's minor version number.
-
uuid:
string
Device's UUID.
Nested Schema : altBeacon
Type:
object
AltBeacon device.
Show Source
-
id1:
string
Device's first ID.
-
id2:
string
Device's second ID.
-
id3:
string
Device's third ID.
Nested Schema : eddystone
Type:
object
Eddystone device.
Show Source
-
eddystoneUid:
object eddystoneUid
Device's UID.
-
eddystoneUrl:
object eddystoneUrl
Device's URL.
Nested Schema : eddystoneUid
Type:
object
Device's UID.
Show Source
-
instance:
string
Individual device's ID.
-
namespace:
string
Namespace that the device is a member of.
Nested Schema : Link
Type:
object
Title:
Show Source
Link
-
href:
string
A relative URL.
-
rel:
Allowed Values:
[ "self", "canonical", "prev", "next" ]
The type of link.
Nested Schema : Place's Address
Type:
object
Title:
Place's Address
GPS address of the place.
Match One
Show Source
Nested Schema : gpsCircle
Type:
object
GPS circle.
Show Source
-
latitude:
number
Latitude of the center of the GPS circle.
-
longitude:
number
Longitude of the center of the GPS circle.
-
radius:
number
GPS circle's radius in meters.
Nested Schema : gpsPolygon
Type:
object
GPS polygon.
Show Source
-
vertices:
array vertices
Minimum Number of Items:
1
GPS polygon's vertices.
Nested Schema : vertices
Type:
array
Minimum Number of Items:
1
GPS polygon's vertices.
Show Source
-
[0]:
object latitudeLongitudePair
Pair of latitude and longitude values for a place.
Nested Schema : latitudeLongitudePair
Type:
object
Pair of latitude and longitude values for a place.
Show Source
-
latitude:
number
Place's latitude.
-
longitude:
number
Place's longitude.
Example Response (application/json)
{
"modifiedOn":"2015-08-08T07:22:44.654Z",
"beacon":{
"iBeacon":{
"major":"1.0",
"minor":"1.1",
"uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D"
}
},
"createdBy":"jdoe",
"name":"RC_WH_01_F01_B001",
"description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
"modifiedBy":"tsmith",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/location/devices/12345"
},
{
"rel":"self",
"href":"/mobile/platform/location/devices/12345"
}
],
"attributes":{
"visibility":"Public",
"manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
"manufacturer":"Abc Company",
"status":"Active"
},
"place":{
"modifiedOn":"2015-08-06T18:37:59.424Z",
"address":{
"gpsPoint":{
"latitude":37.5548,
"longitude":-121.1566
}
},
"createdBy":"jdoe",
"parentPlace":42,
"name":"FixitFast Redwood City Warehouse",
"description":"FixitFast Warehouse in Redwood City",
"modifiedBy":"jdoe",
"links":[
{
"rel":"canonical",
"href":"/mobile/platform/location/places/111"
},
{
"rel":"self",
"href":"/mobile/platform/location/places/111"
}
],
"attributes":{
"equipmentManufacturer":"Abc Corp"
},
"label":"FixitFast Warehouse",
"id":111,
"createdOn":"2015-08-06T18:37:59.424Z"
},
"id":12345,
"createdOn":"2015-08-06T18:37:59.424Z"
}
404 Response
Device ID not found.
Root Schema : Error
Type:
object
Title:
Error
The error JSON object returned by the service.
Show Source
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails:
array o:errorDetails
Minimum Number of Items:
0
Included when the error is caused by multiple issues. -
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : o:errorDetails
Type:
array
Minimum Number of Items:
0
Included when the error is caused by multiple issues.
Show Source
-
[0]:
object Error Detail
Title:
Error Detail
Nested Schema : Error Detail
Type:
object
Title:
Show Source
Error Detail
-
instance:
string
URI to the link that provides more detailed information about the error.
-
o:errorCode:
string
The service's error code.
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Examples
This example shows how to use cURL to retrieve information about a device by submitting a GET request on the REST resource.
curl -i \
-X GET \
-u mobile.user@example.com:password \
-H "Content-Type: application/json; charset=utf-8" \
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce" \
https://fif.cloud.oracle.com/mobile/platform/location/devices/12345
Example of Response Header
Here's an example of the response header:
200 OK
Content-Length: 1084
Content-Type: application/json
Date: Tue, 16 Jun 2015 01:39:07 GMT
Example of Response Body
This example shows the contents of the response body in JSON format:
{
"id": 12345,
"createdOn": "2015-08-06T18:37:59.424Z",
"createdBy": "jdoe",
"modifiedOn": "2015-08-08T07:22:44.654Z",
"modifiedBy": "tsmith",
"name": "RC_WH_01_F01_B001",
"description": "Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
"place":
{
"id": 111,
"createdOn": "2015-08-06T18:37:59.424Z",
"createdBy": "jdoe",
"modifiedOn": "2015-08-06T18:37:59.424Z",
"modifiedBy": "jdoe",
"name": "FixitFast Redwood City Warehouse",
"label": "FixitFast Warehouse",
"parentPlace": 42,
"description": "FixitFast Warehouse in Redwood City",
"address" : {
"gpsPoint" : {
"latitude": 37.5548,
"longitude": -121.1566
}
},
"attributes" : {
"equipmentManufacturer": "Abc Corp"
},
"links": [
{
"rel": "canonical",
"href": "/mobile/platform/location/places/111"
},
{
"rel": "self",
"href": "/mobile/platform/location/places/111"
}
]
},
"beacon": {
"iBeacon" : {
"uuid": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
"major": "1.0",
"minor": "1.1"
}
},
"attributes" : {
"manufacturer": "Abc Company",
"manufacturerId": "10D39AE7-020E-4467-9CB2-DD36366F899D"
"status": "Active",
"visibility": "Public"
},
"links": [
{
"rel": "canonical",
"href": "/mobile/platform/location/devices/12345"
},
{
"rel": "self",
"href": "/mobile/platform/location/devices/12345"
}
]
}