Location Webservice

Selective update location

Selectively update a location

post/api/location/selectiveUpdateLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/location/selectiveUpdateLocation
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

address1string nullable

First line of the address

address2string nullable

Second line of the address

countryCodestring nullable

Country code of the location

descriptionstring nullable

Description of this location

labelsstring[] nullable

Labels offer a way to perform operations across multiple locations if they have the same label

latitudenumber double nullable

Latitude coordinate of the location

locationUuidstring RUUID nullable required

base 64 (url-safe) uuid string

longitudenumber double nullable

Longitude coordinate of the location

namestring nullable

Name of this location

policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

postalCodestring nullable

Postal code of the location

timezoneIdstring nullable

Timezone identifier, e.g. America/Los_Angeles, EST, GMT+0, etc.

Example request

{
  "floorPlans": [
    {
      "mediaUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.