Location Properties API

The Location Properties feature provides options for the placement of the location routing code. The location routing code is configured using the Location API . See Location API.

You can place the routing code at the beginning of the Network VRU label, in the middle of the Network VRU label and the correlation ID, or can choose not to insert the routing code. The Location Properties are the global settings.

https://<server>/unifiedconfig/config/locationproperties

Operations

  • get: Returns the location property data, using the URL https://<server>/unifiedconfig/config/locationproperties.

  • update: Updates a location property data.

Parameters

  • locationRoutingCodeInsertOption: Required. Placement of the location routing code. As this is a global setting, any change in the value applies to all CVP across all datacenter. The following are the key values:

    • beginning - Location routing code at the beginning of the Network VRU label.

    • middle - Location routing code between the Network VRU label and the correlation ID. This is the default value.

    • none - Do not insert the location routing code.

    Default value is middle.

Example Get Response

Code Snippet
Copy<CVP>
<locationProperties>   
<locationRoutingCodeInsertOption>middle</locationRoutingCodeInsertOption>
</locationProperties>
</CVP>

Following are the REST responses received when the REST API runs to configure the location properties data across all sites:

  • Success - Configuration changes persist in AW DB and synchronized with respective devices.

    Code: 200

    Response: Successfully saved

  • Partial Success - Configuration changes persist in AW DB, but failed to synchronize with one or more devices.

    Code: 201

    Response: Configuration update failed for one or more devices. (This occurs when the AW DB is updated but Sync with CVP Call Server failed.)

    Code: 503

    Response: The server is currently busy. Please try again later. (This occurs when data synchronization to a device is in progress.)

    Example API error:
    Code Snippet
    Copy<apiErrors>
<apiError>
<errorMessage>Configuration update failed for one or more devices.</errorMessage>
<errorType>PARTIAL_SUCCESS</errorType>
</apiError>
</apiErrors>

  • Failure- The configuration updates to AW DB is failed.