Add Devices

post

/mobile/system/locationManagement/devices

Creates one or more devices.

Permissions

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : Device Items Array

Type: object

Title: Device Items Array

Show Source

• items: array items
  Minimum Number of Items: 1

  Array of the devices to be created.

{
    "title":"Device Items Array",
    "type":"object",
    "properties":{
        "items":{
            "minItems":1,
            "description":"Array of the devices to be created.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/createDevice"
            }
        }
    }
}

Nested Schema : items

Type: array

Minimum Number of Items: 1

Array of the devices to be created.

Show Source

• [0]: object Create Location Device
  Title: Create Location Device

  The device to be created.

{
    "minItems":1,
    "description":"Array of the devices to be created.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/createDevice"
    }
}

Nested Schema : Create Location Device

Type: object

Title: Create Location Device

The device to be created.

Show Source

• asset: number
  The asset ID that contains the device. A device can be associated with a place or asset, but not both.
• attributes: object Attributes
  Title: Attributes

  Additional Properties Allowed: additionalProperties

  The attributes entered in the UI, as key/value pairs.
• beacon: object Beacon
  Title: Beacon

  Device's identifying information.
• description: string
  Device's description.
• name: string
  User-defined name for the device.
• place: number
  The place ID that contains the device. A device can be associated with a place or asset, but not both.

{
    "description":"The device to be created.",
    "title":"Create Location Device",
    "type":"object",
    "required":[
        "name",
        "beacon"
    ],
    "properties":{
        "beacon":{
            "$ref":"#/definitions/beacon"
        },
        "name":{
            "description":"User-defined name for the device.",
            "type":"string"
        },
        "description":{
            "description":"Device's description.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "place":{
            "description":"The place ID that contains the device. A device can be associated with a place or asset, but not both.",
            "type":"number"
        },
        "asset":{
            "description":"The asset ID that contains the device. A device can be associated with a place or asset, but not both.",
            "type":"number"
        }
    }
}

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

• string

{
    "description":"The attributes entered in the UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Attributes",
    "type":"object",
    "properties":{
    }
}

The attributes entered in the UI, as key/value pairs.

Show Source

{
    "description":"The attributes entered in the UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Attributes",
    "type":"object",
    "properties":{
    }
}

Nested Schema : Beacon

Type: object

Title: Beacon

Device's identifying information.

Match One

Show Source

• object iBeacon
  iBeacon device.
• object altBeacon
  AltBeacon device.
• object eddystone
  Eddystone device.

{
    "description":"Device's identifying information.",
    "title":"Beacon",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/iBeacon"
        },
        {
            "$ref":"#/definitions/altBeacon"
        },
        {
            "$ref":"#/definitions/eddystone"
        }
    ]
}

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.

{
    "description":"iBeacon device.",
    "type":"object",
    "properties":{
        "major":{
            "description":"Device's major version number.",
            "type":"string"
        },
        "minor":{
            "description":"Device's minor version number.",
            "type":"string"
        },
        "uuid":{
            "description":"Device's UUID.",
            "type":"string"
        }
    }
}

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.

{
    "description":"AltBeacon device.",
    "type":"object",
    "properties":{
        "id2":{
            "description":"Device's second ID.",
            "type":"string"
        },
        "id1":{
            "description":"Device's first ID.",
            "type":"string"
        },
        "id3":{
            "description":"Device's third ID.",
            "type":"string"
        }
    }
}

Nested Schema : eddystone

Type: object

Eddystone device.

Show Source

• eddystoneUid: object eddystoneUid
  Device's UID.
• eddystoneUrl: object eddystoneUrl
  Device's URL.

{
    "description":"Eddystone device.",
    "type":"object",
    "properties":{
        "eddystoneUid":{
            "description":"Device's UID.",
            "type":"object",
            "properties":{
                "instance":{
                    "description":"Individual device's ID.",
                    "type":"string"
                },
                "namespace":{
                    "description":"Namespace that the device is a member of.",
                    "type":"string"
                }
            }
        },
        "eddystoneUrl":{
            "description":"Device's URL.",
            "type":"object",
            "properties":{
                "url":{
                    "description":"The URL.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"Device's UID.",
    "type":"object",
    "properties":{
        "instance":{
            "description":"Individual device's ID.",
            "type":"string"
        },
        "namespace":{
            "description":"Namespace that the device is a member of.",
            "type":"string"
        }
    }
}

Nested Schema : eddystoneUrl

Type: object

Device's URL.

Show Source

• url: string
  The URL.

{
    "description":"Device's URL.",
    "type":"object",
    "properties":{
        "url":{
            "description":"The URL.",
            "type":"string"
        }
    }
}

Example Request (application/json)

{
    "items":[
        {
            "beacon":{
                "altBeacon":{
                    "id2":"AFF9",
                    "id1":"B9407F30-F5F8-466E",
                    "id3":"25556B57FE6D"
                }
            },
            "name":"RC_WH_01_F01_B006",
            "description":"Beacon on 2nd Floor in FixitFast Warehouse in Redwood City",
            "attributes":{
                "visibility":"Public",
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "manufacturer":"Abc Company",
                "status":"Active"
            },
            "asset":333
        },
        {
            "beacon":{
                "iBeacon":{
                    "major":"1.0",
                    "minor":"1.1",
                    "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D"
                }
            },
            "name":"RC_WH_01_F01_B001",
            "description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
            "attributes":{
                "visibility":"Public",
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "manufacturer":"Abc Company",
                "status":"Active"
            },
            "place":111
        }
    ]
}

Response

Supported Media Types

• application/json

200 Response

The location devices were created successfully.

Body ()

Root Schema : Devices Array

Type: object

Title: Devices Array

Show Source

• items: array items
  Minimum Number of Items: 1

  Array of the created devices.

{
    "title":"Devices Array",
    "type":"object",
    "properties":{
        "items":{
            "minItems":1,
            "description":"Array of the created devices.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/returnDevice"
            }
        }
    }
}

Nested Schema : items

Type: array

Minimum Number of Items: 1

Array of the created devices.

Show Source

• [0]: object Location Device
  Title: Location Device

  The created or updated device.

{
    "minItems":1,
    "description":"Array of the created devices.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/returnDevice"
    }
}

Nested Schema : Location Device

Type: object

Title: Location Device

The created or updated device.

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: additionalProperties

  The 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.

{
    "description":"The created or updated device.",
    "title":"Location Device",
    "type":"object",
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "properties":{
        "modifiedOn":{
            "description":"When the device was last modified.",
            "type":"string"
        },
        "beacon":{
            "$ref":"#/definitions/beacon"
        },
        "createdBy":{
            "description":"User who added the device.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the device.",
            "type":"string"
        },
        "description":{
            "description":"Device's description.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the device.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "place":{
            "description":"The place that contains the device.",
            "$ref":"#/definitions/associatedPlace"
        },
        "id":{
            "description":"Device's ID.",
            "type":"number"
        },
        "asset":{
            "description":"The asset that contains the device.",
            "$ref":"#/definitions/associatedAsset"
        },
        "createdOn":{
            "description":"When the device was added.",
            "type":"string"
        }
    }
}

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: additionalProperties

  The 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.

{
    "description":"The properties for an associated asset. This object doesn't include the `devices` property because the associated device is the containing object.",
    "title":"Associated Asset",
    "type":"object",
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "properties":{
        "modifiedOn":{
            "description":"When the asset was last modified.",
            "type":"string"
        },
        "createdBy":{
            "description":"User who added the asset.",
            "type":"string"
        },
        "lastKnownLocation":{
            "$ref":"#/definitions/lastKnownLocation"
        },
        "name":{
            "description":"User-defined name for the asset.",
            "type":"string"
        },
        "description":{
            "description":"Asset's description.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the asset.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "label":{
            "description":"Asset's label.",
            "type":"string"
        },
        "id":{
            "description":"Asset's ID.",
            "type":"number"
        },
        "createdOn":{
            "description":"When the asset was added.",
            "type":"string"
        }
    }
}

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

• string

{
    "description":"The attributes entered in the UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Attributes",
    "type":"object",
    "properties":{
    }
}

The attributes entered in the UI, as key/value pairs.

Show Source

{
    "description":"The attributes entered in the UI, as key/value pairs.",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Attributes",
    "type":"object",
    "properties":{
    }
}

Nested Schema : Beacon

Type: object

Title: Beacon

Device's identifying information.

Match One

Show Source

• object iBeacon
  iBeacon device.
• object altBeacon
  AltBeacon device.
• object eddystone
  Eddystone device.

{
    "description":"Device's identifying information.",
    "title":"Beacon",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/iBeacon"
        },
        {
            "$ref":"#/definitions/altBeacon"
        },
        {
            "$ref":"#/definitions/eddystone"
        }
    ]
}

Nested Schema : Relationship links

Type: array

Title: Relationship links

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• [0]: object Link
  Title: Link

{
    "minItems":1,
    "uniqueItems":true,
    "title":"Relationship links",
    "type":"array",
    "items":{
        "$ref":"#/definitions/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: additionalProperties

  The 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.

{
    "description":"The properties for an associated place. This object doesn't include the `devices` property because the associated device is the containing object.",
    "title":"Associated Place",
    "type":"object",
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "properties":{
        "address":{
            "$ref":"#/definitions/placeAddress"
        },
        "hasChildren":{
            "description":"Set to `true` if this place is a parent of other places.",
            "type":"boolean"
        },
        "description":{
            "description":"Place's description.",
            "type":"string"
        },
        "label":{
            "description":"Place's label.",
            "type":"string"
        },
        "createdOn":{
            "description":"When the place was added.",
            "type":"string"
        },
        "modifiedOn":{
            "description":"When the place was last modified.",
            "type":"string"
        },
        "createdBy":{
            "description":"User who added the place.",
            "type":"string"
        },
        "parentPlace":{
            "description":"Place's parent place.",
            "type":"number"
        },
        "name":{
            "description":"User-defined name for the place.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the place.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "id":{
            "description":"Place's ID.",
            "type":"number"
        }
    }
}

Nested Schema : Last Known Location

Type: object

Title: Last Known Location

Last known location of the asset.

Match One

Show Source

• object gpsPoint
  GPS point.
• integer
  Title: placeId

  ID of the associated place.

{
    "description":"Last known location of the asset.",
    "title":"Last Known Location",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/gpsPoint"
        },
        {
            "$ref":"#/definitions/placeId"
        }
    ]
}

Nested Schema : gpsPoint

Type: object

GPS point.

Show Source

• latitude: number
  GPS point's latitude
• longitude: number
  GPS point's longitude.

{
    "description":"GPS point.",
    "type":"object",
    "properties":{
        "latitude":{
            "description":"GPS point's latitude",
            "type":"number"
        },
        "longitude":{
            "description":"GPS point's longitude.",
            "type":"number"
        }
    }
}

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.

{
    "description":"iBeacon device.",
    "type":"object",
    "properties":{
        "major":{
            "description":"Device's major version number.",
            "type":"string"
        },
        "minor":{
            "description":"Device's minor version number.",
            "type":"string"
        },
        "uuid":{
            "description":"Device's UUID.",
            "type":"string"
        }
    }
}

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.

{
    "description":"AltBeacon device.",
    "type":"object",
    "properties":{
        "id2":{
            "description":"Device's second ID.",
            "type":"string"
        },
        "id1":{
            "description":"Device's first ID.",
            "type":"string"
        },
        "id3":{
            "description":"Device's third ID.",
            "type":"string"
        }
    }
}

Nested Schema : eddystone

Type: object

Eddystone device.

Show Source

• eddystoneUid: object eddystoneUid
  Device's UID.
• eddystoneUrl: object eddystoneUrl
  Device's URL.

{
    "description":"Eddystone device.",
    "type":"object",
    "properties":{
        "eddystoneUid":{
            "description":"Device's UID.",
            "type":"object",
            "properties":{
                "instance":{
                    "description":"Individual device's ID.",
                    "type":"string"
                },
                "namespace":{
                    "description":"Namespace that the device is a member of.",
                    "type":"string"
                }
            }
        },
        "eddystoneUrl":{
            "description":"Device's URL.",
            "type":"object",
            "properties":{
                "url":{
                    "description":"The URL.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"Device's UID.",
    "type":"object",
    "properties":{
        "instance":{
            "description":"Individual device's ID.",
            "type":"string"
        },
        "namespace":{
            "description":"Namespace that the device is a member of.",
            "type":"string"
        }
    }
}

Nested Schema : eddystoneUrl

Type: object

Device's URL.

Show Source

• url: string
  The URL.

{
    "description":"Device's URL.",
    "type":"object",
    "properties":{
        "url":{
            "description":"The URL.",
            "type":"string"
        }
    }
}

Nested Schema : Link

Type: object

Title: Link

Show Source

• href: string
  A relative URL.
• rel:
  Allowed Values: [ "self", "canonical", "prev", "next" ]

  The type of link.

{
    "title":"Link",
    "type":"object",
    "required":[
        "rel",
        "href"
    ],
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    }
}

Nested Schema : Place's Address

Type: object

Title: Place's Address

GPS address of the place.

Match One

Show Source

• object gpsPoint
  GPS point.
• object gpsCircle
  GPS circle.
• object gpsPolygon
  GPS polygon.

{
    "description":"GPS address of the place.",
    "title":"Place's Address",
    "type":"object",
    "x-oneOf":[
        {
            "$ref":"#/definitions/gpsPoint"
        },
        {
            "$ref":"#/definitions/gpsCircle"
        },
        {
            "$ref":"#/definitions/gpsPolygon"
        }
    ]
}

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.

{
    "description":"GPS circle.",
    "type":"object",
    "properties":{
        "latitude":{
            "description":"Latitude of the center of the GPS circle.",
            "type":"number"
        },
        "radius":{
            "description":"GPS circle's radius in meters.",
            "type":"number"
        },
        "longitude":{
            "description":"Longitude of the center of the GPS circle.",
            "type":"number"
        }
    }
}

Nested Schema : gpsPolygon

Type: object

GPS polygon.

Show Source

• vertices: array vertices
  Minimum Number of Items: 1

  GPS polygon's vertices.

{
    "description":"GPS polygon.",
    "type":"object",
    "properties":{
        "vertices":{
            "minItems":1,
            "description":"GPS polygon's vertices.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/latitudeLongitudePair"
            }
        }
    }
}

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.

{
    "minItems":1,
    "description":"GPS polygon's vertices.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/latitudeLongitudePair"
    }
}

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.

{
    "description":"Pair of latitude and longitude values for a place.",
    "type":"object",
    "properties":{
        "latitude":{
            "description":"Place's latitude.",
            "type":"number"
        },
        "longitude":{
            "description":"Place's longitude.",
            "type":"number"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "modifiedOn":"2015-08-08T07:22:44.654Z",
            "beacon":{
                "altBeacon":{
                    "id2":"AFF9",
                    "id1":"B9407F30-F5F8-466E",
                    "id3":"25556B57FE6D"
                }
            },
            "createdBy":"jdoe",
            "name":"RC_WH_01_F01_B006",
            "description":"Beacon on hospital bed #233 in City Hospital",
            "modifiedBy":"tsmith",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/devices/11111"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/devices/11111"
                }
            ],
            "attributes":{
                "visibility":"Public",
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "manufacturer":"Abc Company",
                "status":"Active"
            },
            "id":11111,
            "asset":{
                "modifiedOn":"2015-08-06T18:37:59.424Z",
                "createdBy":"jdoe",
                "lastKnownLocation":{
                    "placeId":244
                },
                "name":"hospital bed #233",
                "description":"model 1225 hospital bed",
                "modifiedBy":"jdoe",
                "links":[
                    {
                        "rel":"canonical",
                        "href":"/mobile/platform/location/assets/333"
                    },
                    {
                        "rel":"self",
                        "href":"/mobile/platform/location/assets/333"
                    }
                ],
                "attributes":{
                    "SJId":"6754843090",
                    "EquipmentManufacturer":"Example Company"
                },
                "label":"hospital bed",
                "id":333,
                "createdOn":"2015-08-06T18:37:59.424Z"
            },
            "createdOn":"2015-08-06T18:37:59.424Z"
        },
        {
            "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"
        }
    ]
}

400 Response

Bad request.

Body ()

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

  List of the issues that cause the error. 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.

{
    "description":"The error JSON object returned by the service.",
    "title":"Error",
    "type":"object",
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "minItems":0,
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/errorDetail"
            }
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    }
}

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

• [0]: object Error Detail
  Title: Error Detail

{
    "minItems":0,
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/errorDetail"
    }
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The 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.

{
    "title":"Error Detail",
    "type":"object",
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "properties":{
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        }
    }
}

Examples

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

curl -i
-X POST 
-u [e-mail]:password
-d @devices.json
-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/devices

Examples of Request Body

The following shows an example of the request body.

{
    "items" : [
        {
            "name": "RC_WH_01_F01_B001",
            "description": "Forklift beacon",
            "beacon": {
               "iBeacon" : {
                 "uid": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                 "major": "1.0",
                 "minor": "1.1"
               }
             },
            "properties" : {
                "manufacturer": "Gimbal",  
                "manufacturerId": "10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status": "Active",
                "visibility": "Public"
            }
        }
    ]
}

Example of Response Header

The following shows an example of the response header:

200 OK
Content-Length: 569
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": 33,
            "createdOn": "2017-09-21T23:34:11.526Z",
            "createdBy": "administrator",
            "modifiedOn": "2017-09-21T23:34:11.526Z",
            "modifiedBy": "administrator",
            "name": "RC_WH_01_F01_B001",
            "description": "Forklift beacon",
            "beacon": {
                "iBeacon": {
                    "major": "1.0",
                    "minor": "1.1",
                    "uuid": "B9407F30-F5F8-466E-AFF9-25556B57FE6D"
                }
            },
            "attributes": {
                "manufacturer": "Gimbal",
                "manufacturerId": "10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status": "Active",
                "visibility": "Public"
            },
            "links": [
                {
                    "rel": "canonical",
                    "href": "/mobile/platform/location/devices/33"
                },
                {
                    "rel": "self",
                    "href": "/mobile/platform/location/devices/33"
                }
            ]
        }
    ]
}