Jump to

• Request
• Response
• Examples

Update Place

put

/mobile/system/locationManagement/places/{id}

Updates the place that matches the ID.

Permissions

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

Request

Supported Media Types

• application/json

Path Parameters

• id: integer

  The ID of the place. This ID must be an existing place ID.

Body ()

Root Schema : Update Place

Type: object

Title: Update Place

The place fields to be updated.

Show Source

• address(optional): object Place's Address
  Title: Place's Address

  GPS address of the place.
• attributes(optional): object Attributes
  Title: Attributes

  Additional Properties Allowed: additionalProperties

  The attributes entered in the MCS UI, as key/value pairs.
• description(optional): string
  Place's description.
• devices(optional): array devices
  Minimum Number of Items: 0

  IDs of devices that are associated with this place. Typically one device, but there can be multiple devices.
• label(optional): string
  Place's label.
• name(optional): string
  User-defined name for the place. Must be unique.
• parentPlace(optional): number
  Place ID of the place's parent.

{
    "title":"Update Place",
    "description":"The place fields to be updated.",
    "properties":{
        "address":{
            "$ref":"#/definitions/placeAddress"
        },
        "description":{
            "description":"Place's description.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the place. Must be unique.",
            "type":"string"
        },
        "label":{
            "description":"Place's label.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "devices":{
            "items":{
                "type":"integer"
            },
            "description":"IDs of devices that are associated with this place. Typically one device, but there can be multiple devices.",
            "minItems":0,
            "type":"array"
        },
        "parentPlace":{
            "description":"Place ID of the place's parent.",
            "type":"number"
        }
    },
    "type":"object"
}

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.

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

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

• string

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

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

Show Source

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

Nested Schema : devices

Type: array

Minimum Number of Items: 0

IDs of devices that are associated with this place. Typically one device, but there can be multiple devices.

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "description":"IDs of devices that are associated with this place. Typically one device, but there can be multiple devices.",
    "minItems":0,
    "type":"array"
}

Nested Schema : gpsPoint

Type: object

GPS point.

Show Source

• latitude(optional): number
  GPS point's latitude
• longitude(optional): number
  GPS point's longitude.

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

Nested Schema : gpsCircle

Type: object

GPS circle.

Show Source

• latitude(optional): number
  Latitude of the center of the GPS circle.
• longitude(optional): number
  Longitude of the center of the GPS circle.
• radius(optional): number
  GPS circle's radius in meters.

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

Nested Schema : gpsPolygon

Type: object

GPS polygon.

Show Source

• vertices(optional): array vertices
  Minimum Number of Items: 1

  GPS polygon's vertices.

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

Nested Schema : vertices

Type: array

Minimum Number of Items: 1

GPS polygon's vertices.

Show Source

• Array of: object latitudeLongitudePair
  Pair of latitude and longitude values for a place.

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

Nested Schema : latitudeLongitudePair

Type: object

Pair of latitude and longitude values for a place.

Show Source

• latitude(optional): number
  Place's latitude.
• longitude(optional): number
  Place's longitude.

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

Example Request (application/json)

{
    "address":{
        "gpsPoint":{
            "longitude":-121.1566,
            "latitude":37.5548
        }
    },
    "devices":[
        1111
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The location place was updated successfully.

Body ()

Root Schema : Place

Type: object

Title: Place

The created or updated place.

Show Source

• address(optional): object Place's Address
  Title: Place's Address

  GPS address of the place.
• attributes(optional): object Attributes
  Title: Attributes

  Additional Properties Allowed: additionalProperties

  The attributes entered in the MCS UI, as key/value pairs.
• children(optional): array children
  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.
• createdBy: string
  User who added the place.
• createdOn: string
  When the place was added to MCS.
• description: string
  Place's description.
• devices(optional): array devices
  Minimum Number of Items: 0

  Devices associated with this place. Typically one device, but there can be multiple devices.
• hasChildren(optional): boolean
  Set to `true` if this place is a parent of other places.
• id: number
  Place's ID.
• label(optional): string
  Place's label.
• links: array Relationship links
  Title: Relationship links

  Minimum Number of Items: 1

  Unique Items Required: true
• modifiedBy(optional): string
  User who last modified the place.
• modifiedOn(optional): string
  When the place was last modified.
• name: string
  User-defined name for the place.
• parentPlace(optional): number
  Place ID of the place's parent.

{
    "title":"Place",
    "description":"The created or updated place.",
    "properties":{
        "createdOn":{
            "description":"When the place was added to MCS.",
            "type":"string"
        },
        "id":{
            "description":"Place's ID.",
            "type":"number"
        },
        "modifiedOn":{
            "description":"When the place was last modified.",
            "type":"string"
        },
        "hasChildren":{
            "description":"Set to `true` if this place is a parent of other places.",
            "type":"boolean"
        },
        "createdBy":{
            "description":"User who added the place.",
            "type":"string"
        },
        "address":{
            "$ref":"#/definitions/placeAddress"
        },
        "description":{
            "description":"Place's description.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the place.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the place.",
            "type":"string"
        },
        "children":{
            "items":{
                "$ref":"#/definitions/returnPlace"
            },
            "description":"Places that are the child places of this place. This includes the full hierarchy of places that descend from this place.",
            "minItems":0,
            "type":"array"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "label":{
            "description":"Place's label.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        },
        "devices":{
            "items":{
                "$ref":"#/definitions/associatedDevice"
            },
            "description":"Devices associated with this place. Typically one device, but there can be multiple devices.",
            "minItems":0,
            "type":"array"
        },
        "parentPlace":{
            "description":"Place ID of the place's parent.",
            "type":"number"
        }
    },
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "type":"object"
}

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.

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

Nested Schema : Attributes

Type: object

Title: Attributes

Additional Properties Allowed

Show Source

• string

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

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

Show Source

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

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

• Array of: object Place
  Title: Place

  The created or updated place.

{
    "items":{
        "$ref":"#/definitions/returnPlace"
    },
    "description":"Places that are the child places of this place. This includes the full hierarchy of places that descend from this place.",
    "minItems":0,
    "type":"array"
}

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

• Array of: object 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.

{
    "items":{
        "$ref":"#/definitions/associatedDevice"
    },
    "description":"Devices associated with this place. Typically one device, but there can be multiple devices.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Relationship links

Type: array

Title: Relationship links

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: object Link
  Title: Link

{
    "title":"Relationship links",
    "items":{
        "$ref":"#/definitions/link"
    },
    "minItems":1,
    "uniqueItems":true,
    "type":"array"
}

Nested Schema : gpsPoint

Type: object

GPS point.

Show Source

• latitude(optional): number
  GPS point's latitude
• longitude(optional): number
  GPS point's longitude.

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

Nested Schema : gpsCircle

Type: object

GPS circle.

Show Source

• latitude(optional): number
  Latitude of the center of the GPS circle.
• longitude(optional): number
  Longitude of the center of the GPS circle.
• radius(optional): number
  GPS circle's radius in meters.

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

Nested Schema : gpsPolygon

Type: object

GPS polygon.

Show Source

• vertices(optional): array vertices
  Minimum Number of Items: 1

  GPS polygon's vertices.

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

Nested Schema : vertices

Type: array

Minimum Number of Items: 1

GPS polygon's vertices.

Show Source

• Array of: object latitudeLongitudePair
  Pair of latitude and longitude values for a place.

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

Nested Schema : latitudeLongitudePair

Type: object

Pair of latitude and longitude values for a place.

Show Source

• latitude(optional): number
  Place's latitude.
• longitude(optional): number
  Place's longitude.

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

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

• attributes(optional): object Attributes
  Title: Attributes

  Additional Properties Allowed: additionalProperties

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

  Device's identifying information.
• createdBy: string
  User who added the device.
• createdOn: string
  When the device was added to MCS.
• 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(optional): string
  User who last modified the device.
• modifiedOn(optional): string
  When the device was last modified.
• name: string
  User-defined name for the device.

{
    "title":"Associated Location Device",
    "description":"The properties for an associated location device. Note that this object doesn't contain the `asset` and `place` properties.",
    "properties":{
        "id":{
            "description":"Device's ID.",
            "type":"number"
        },
        "createdOn":{
            "description":"When the device was added to MCS.",
            "type":"string"
        },
        "modifiedOn":{
            "description":"When the device was last modified.",
            "type":"string"
        },
        "createdBy":{
            "description":"User who added the device.",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User who last modified the device.",
            "type":"string"
        },
        "description":{
            "description":"Device's description.",
            "type":"string"
        },
        "name":{
            "description":"User-defined name for the device.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/links"
        },
        "beacon":{
            "$ref":"#/definitions/beacon"
        },
        "attributes":{
            "$ref":"#/definitions/objectAttributes"
        }
    },
    "required":[
        "id",
        "createdOn",
        "createdBy",
        "name",
        "description",
        "links"
    ],
    "type":"object"
}

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.

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

Nested Schema : iBeacon

Type: object

iBeacon device.

Show Source

• major(optional): string
  Device's major version number.
• minor(optional): string
  Device's minor version number.
• uuid(optional): string
  Device's UUID.

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

Nested Schema : altBeacon

Type: object

AltBeacon device.

Show Source

• id1(optional): string
  Device's first ID.
• id2(optional): string
  Device's second ID.
• id3(optional): string
  Device's third ID.

{
    "description":"AltBeacon device.",
    "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"
        }
    },
    "type":"object"
}

Nested Schema : eddystone

Type: object

Eddystone device.

Show Source

• eddystoneUid(optional): object eddystoneUid
  Device's UID.
• eddystoneUrl(optional): object eddystoneUrl
  Device's URL.

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

Nested Schema : eddystoneUid

Type: object

Device's UID.

Show Source

• instance(optional): string
  Individual device's ID.
• namespace(optional): string
  Namespace that the device is a member of.

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

Nested Schema : eddystoneUrl

Type: object

Device's URL.

Show Source

• url(optional): string
  The URL.

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

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",
    "properties":{
        "rel":{
            "description":"The type of link.",
            "enum":[
                "self",
                "canonical",
                "prev",
                "next"
            ]
        },
        "href":{
            "description":"A relative URL.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "type":"object"
}

Example Response (application/json)

{
    "createdOn":"2015-08-06T18:37:59.424Z",
    "id":111,
    "modifiedOn":"2015-08-06T18:37:59.424Z",
    "createdBy":"jdoe",
    "address":{
        "gpsPoint":{
            "longitude":-121.1566,
            "latitude":37.5548
        }
    },
    "description":"FixitFast Warehouse in Redwood City",
    "modifiedBy":"jdoe",
    "name":"FixitFast Redwood City Warehouse",
    "links":[
        {
            "rel":"canonical",
            "href":"/mobile/platform/location/places/111"
        },
        {
            "rel":"self",
            "href":"/mobile/platform/location/places/111"
        }
    ],
    "label":"FixitFast Warehouse",
    "properties":{
        "equipmentManufacturer":"Abc Corp"
    },
    "devices":[
        {
            "id":1111,
            "createdOn":"2016-03-03T21:31:28.758+0000",
            "modifiedOn":"2016-03-03T21:31:28.758+0000",
            "createdBy":"jdoe",
            "modifiedBy":"jdoe",
            "description":"Beacon on 1st Floor in FixitFast Warehouse in Redwood City",
            "name":"RC_WH_01_F01_B004",
            "links":[
                {
                    "rel":"canonical",
                    "href":"/mobile/platform/location/devices/1111"
                },
                {
                    "rel":"self",
                    "href":"/mobile/platform/location/devices/1111"
                }
            ],
            "properties":{
                "manufacturerId":"10D39AE7-020E-4467-9CB2-DD36366F899D",
                "status":"Active",
                "visibility":"Public",
                "manufacturer":"Gimbal"
            },
            "beacon":{
                "iBeacon":{
                    "minor":"1.1",
                    "uuid":"B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "major":"1.0"
                }
            }
        }
    ],
    "parentPlace":42
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud 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
  Mobile Cloud Service error code.
• o:errorDetails(optional): 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "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"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

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

• Array of: object Error Detail
  Title: Error Detail

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

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
  Mobile Cloud Service 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",
    "properties":{
        "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:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

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

• 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
  Mobile Cloud Service error code.
• o:errorDetails(optional): 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.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "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"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

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

• Array of: object Error Detail
  Title: Error Detail

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

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
  Mobile Cloud Service 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",
    "properties":{
        "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:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Back to Top

Examples

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

curl -i
-X PUT 
-u [e-mail]:mypassword
-d update.json
-H "Content-Type: application/json; charset=utf-8"
-H "Oracle-Mobile-Backend-ID: ABCD9278-091f-41aa-9cb2-184bd0586fce"
https://fif.cloud.oracle.com/mobile/system/locationManagement/places/32

Example of Request Body

The following example shows the contents of the request body. This example associates the place with a parent place.

{
    "parentPlace": 51
}

Example of Response Header

The following shows an example of the response header.

200 OK
Content-Length: 955
Content-Type: application/json
Date: Fri, 22 Sep 2017 00:08:29 GMT

Example of Response Body

The following example shows, in JSON format, the contents of the response body with the new parent place:

{
    "id": 32,
    "createdOn": "2017-09-19T23:23:43.238Z",
    "createdBy": "administrator",
    "modifiedOn": "2017-09-22T00:50:17.360Z",
    "modifiedBy": "administrator",
    "name": "l1b1",
    "label": "lot 1 block 1",
    "parentPlace": 51,
    "description": "Lot 1 block 1 New City",
    "hasChildren": false,
    "address": {
        "gpsCircle": {
            "longitude": -120.8745,
            "latitude": 37.9856,
            "radius": 29999.99999998
        }
    },
    "attributes": {
        "acres": ".25"
    },
    "links": [
        {
            "rel": "canonical",
            "href": "/mobile/platform/location/places/32"
        },
        {
            "rel": "self",
            "href": "/mobile/platform/location/places/32"
        }
    ]
}

Back to Top