1. REST API Reference for Oracle Mobile Cloud Enterprise - Platform APIs
  2. Tasks
  3. Location Management

Add Places from File

post

/mobile/system/locationManagement/places/upload

Adds the places that are defined in a file in CSV format.

The CSV format is: name,label,description,gpsPointLat:gpsPointLong,gpsCircleLat:gpsCircleLong:gpsCircleRadius,gpsPolygonLat:gpsPolygonLong,attributeKey1=attributeValue1,attributeKey2=attributeValue2

You can have multiple gpsPolygonLat:gpsPolygonLong values separated by ; (semicolon).

The attributeKey=attributeValue value is optional, and you can have multiple attributeKey=attributeValue values separated by a , (comma).

For example:

#version=1.0
FixItFast Redwood City Warehouse #1,FixItFast Warehouse,FixItFast Warehouse in Redwood City,37.5548:-121.1566,,,hours=9am-6pm
FixItFast Redwood City Warehouse #2,FixItFast Warehouse,FixItFast Warehouse in Redwood City,,37.9856:-120.8745:30000,,hours=8am-5pm
FixItFast Redwood City Warehouse #3,FixItFast Warehouse,FixItFast Warehouse in Redwood City,,,37.8453:-121.7845;37.1248:-120.9853;37.6983:-121.7758,hours=6am-3pm

Permissions

Only team members with the Administrator role can access the Location Management API.

Request

Supported Media Types
Body ()
A body of type:
  • binary/octet-stream
Root Schema : schema

Response

Supported Media Types

200 Response

The location places were created successfully.
Body ()
Root Schema : Place Items Array
Type: object
Title: Place Items Array
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 1
Array of the created places.
Show Source
Nested Schema : Place
Type: object
Title: Place
The created or updated place.
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 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
Nested Schema : devices
Type: array
Minimum Number of Items: 0
Devices associated with this place. Typically one device, but there can be multiple devices.
Show Source
  • Associated Location Device
    Title: Associated Location Device
    The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.
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 : 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
Nested Schema : Beacon
Type: object
Title: Beacon
Device's identifying information.
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
Example Response (application/json)
{
    "items":[
        {
            "modifiedOn":"2015-08-06T18:37:41.995Z",
            "address":{
                "gpsPoint":{
                    "latitude":37.5548,
                    "longitude":-121.1566
                }
            },
            "createdBy":"jdoe",
            "hasChildren":false,
            "name":"FixItFast Redwood City Warehouse #1",
            "description":"FixItFast Warehouse in Redwood City",
            "modifiedBy":"jdoe",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/places/113"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/places/113"
                }
            ],
            "attributes":{
                "hours":"9am-6pm"
            },
            "label":"FixItFast Warehouse",
            "id":113,
            "createdOn":"2015-08-06T18:37:41.995Z"
        },
        {
            "modifiedOn":"2015-08-06T18:37:42.093Z",
            "address":{
                "gpsCircle":{
                    "latitude":37.9856,
                    "radius":30000,
                    "longitude":-120.8745
                }
            },
            "createdBy":"jdoe",
            "hasChildren":false,
            "name":"FixItFast Redwood City Warehouse #2",
            "description":"FixItFast Warehouse in Redwood City",
            "modifiedBy":"jdoe",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/places/114"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/places/114"
                }
            ],
            "attributes":{
                "hours":"8am-5pm"
            },
            "label":"FixItFast Warehouse",
            "id":114,
            "createdOn":"2015-08-06T18:37:42.093Z"
        },
        {
            "modifiedOn":"2015-08-06T18:37:42.174Z",
            "address":{
                "gpsPolygon":{
                    "vertices":[
                        {
                            "latitude":37.8453,
                            "longitude":-121.7845
                        },
                        {
                            "latitude":37.1248,
                            "longitude":-120.9853
                        },
                        {
                            "latitude":37.6983,
                            "longitude":-121.7758
                        }
                    ]
                }
            },
            "createdBy":"jdoe",
            "hasChildren":false,
            "name":"FixItFast Redwood City Warehouse #3",
            "description":"FixItFast Warehouse in Redwood City",
            "modifiedBy":"jdoe",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/places/115"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/places/115"
                }
            ],
            "attributes":{
                "hours":"6am-3pm"
            },
            "label":"FixItFast Warehouse",
            "id":115,
            "createdOn":"2015-08-06T18:37:42.174Z"
        }
    ]
}

400 Response

Bad request.

Body ()
Root Schema : Error
Type: object
Title: Error
The error JSON object returned by the 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

Examples

The following example shows how to create places from a CSV file by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -i
-X POST 
-u administrator@example.com:password
--data-binary @places.csv
-H "Content-Type: application/json; charset=utf-8"
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce"
http://fif.cloud.oracle.com/mobile/system/locationManagement/places/upload

Examples of Request Body

The following shows an example of the upload file.

#version=1.0
entranceSouth,public access,South Entrance New City,37.845:-121.7845,,,guardStation=true

Example of Response Header

The following shows an example of the response header:

200 OK
Content-Length: 497
Content-Type: application/json
Date: Tue, 19 Sep 2017 21:48:18 GMT

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "items":[
    {
      "id":50,
      "createdOn":"2017-09-21T21:56:27.296Z",
      "createdBy":"administrator",
      "modifiedOn":"2017-09-21T21:56:27.296Z",
      "modifiedBy":"administrator",
      "name":"entranceSouth",
      "label":"public access",
      "description":"South Entrance New City",
      "hasChildren":false,
      "address":{
        "gpsPoint":{
          "longitude":-121.7845,
          "latitude":37.845
        }
      },
      "attributes":{
        "guardStation":"true"
      },
      "links":[
        {
          "rel":"canonical",
          "href":"/mobile/platform/location/places/50"
        },
        {
          "rel":"self",
          "href":"/mobile/platform/location/places/50"
        }
      ]
    }
  ]
}