1. REST API for Oracle Mobile Cloud Service
  2. Tasks
  3. Location

Return a Place by ID

get

/mobile/platform/location/places/{id}

Retrieves the place 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 mobile user, then you must be a member of the realm that's associated with the mobile backend.

Request

Path Parameters

  • The ID of the place to be returned. This ID must be an existing place ID.

Back to Top

Response

Supported Media Types

200 Response

The place was retrieved successfully.
Body ()
Root Schema : Place
Type: object
Title: Place
The long format includes all properties. The short format contains only `id`, `name`, `description`, `children`, and `label`. The short format applies to `POST /mobile/platform/location/places` responses only.
Show Source
Nested Schema : Place's Address
Type: object
Title: Place's Address
GPS address of the place.
Match One
Show Source
Nested Schema : Attributes
Type: object
Title: Attributes
Additional Properties Allowed
Show Source
The attributes entered in the MCS UI, as key/value pairs.
Show Source
Nested Schema : children
Type: array
Minimum Number of Items: 0
Places that are the child places of this place. This includes the full hierarchy of places that descend from this place.
Show Source
  • Place
    Title: Place
    The long format includes all properties. The short format contains only `id`, `name`, `description`, `children`, and `label`. The short format applies to `POST /mobile/platform/location/places` responses only.
Nested Schema : descendantDevices
Type: array
Minimum Number of Items: 0
Devices that are associated with this place and all its child places. This property is included in query results when the `descendantDevices` query parameter is set to `true`. All devices found are included in short form only.
Show Source
  • Location Device
    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.
Nested Schema : devices
Type: array
Minimum Number of Items: 0
Devices associated with this asset. Typically one device, but there can be multiple devices.
Show Source
Nested Schema : gpsPoint
Type: object
GPS point.
Show Source
Nested Schema : gpsCircle
Type: object
GPS circle.
Show Source
Nested Schema : gpsPolygon
Type: object
GPS polygon.
Show Source
Nested Schema : vertices
Type: array
Minimum Number of Items: 1
GPS polygon's vertices.
Show Source
Nested Schema : latitudeLongitudePair
Type: object
Pair of latitude and longitude values for a place.
Show Source
Nested 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
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
Nested Schema : Beacon
Type: object
Title: Beacon
Device's identifying information.
Match One
Show Source
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
Nested Schema : Last Known Location
Type: object
Title: Last Known Location
Last known location of the asset.
Match One
Show Source
Nested Schema : iBeacon
Type: object
iBeacon device.
Show Source
Nested Schema : altBeacon
Type: object
AltBeacon device.
Show Source
Nested Schema : eddystone
Type: object
Eddystone device.
Show Source
Nested Schema : eddystoneUid
Type: object
Device's UID.
Show Source
Nested Schema : eddystoneUrl
Type: object
Device's URL.
Show Source
Nested Schema : Associated Location Device
Type: object
Title: Associated Location Device
The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.
Show Source
Example Response (application/json)
{
    "id":111,
    "createdOn":"2015-08-06T18:37:59.424Z",
    "modifiedOn":"2015-08-06T18:37:59.424Z",
    "createdBy":"jdoe",
    "address":{
        "gpsPoint":{
            "longitude":-121.1566,
            "latitude":37.5548
        }
    },
    "modifiedBy":"jdoe",
    "description":"FixitFast Warehouse in Redwood City",
    "name":"FixitFast Redwood City Warehouse",
    "label":"FixitFast Warehouse",
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/platform/location/places/111"
        },
        {
            "rel":"self",
            "href":"/mobile/platform/location/places/111"
        }
    ],
    "attributes":{
        "equipmentManufacturer":"Abc Corp"
    },
    "parentPlace":42
}

404 Response

Place ID not found.

Body ()
Root Schema : Error
Type: object
Title: Error
The error JSON object returned by Mobile Cloud Service.
Show Source
Nested Schema : o:errorDetails
Type: array
Minimum Number of Items: 0
List of the issues that cause the error. Included when the error is caused by multiple issues.
Show Source
Nested Schema : Error Detail
Type: object
Title: Error Detail
Show Source
Back to Top

Examples

This example shows how to use cURL to retrieve information about a place 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/places/111

Example of Response Header

Here's an example of the response header:

200 OK
Content-Length: 455
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": 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"
    }
  ]
}
Back to Top