We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

Location Feature REST API

This API exposes operations to allow management of Location features within the Cxense Advertising platform.

This API can be accessed by users with the appropriate permissions to manage Location features and supports the following combination of operations on Location feature domain objects:

Object

Supported operations

Location feature list

GET

Location feature

POST, GET, PUT and DELETE

Retrieving the list of Location features saved against a Campaign or Ad

The GET operation is supported for listing existing Location features.

GET

Retrieve all of the Location features saved at or below the Campaign or Ad with the given parentId. One call using the id of a Campaign will return all of the Location features stored against the Campaign and all of Ads in a single response.

https://{cxadbaseurl}/api/secure/locationFeatures/{parentId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad for which the Location features are to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/locationFeatures/0000000000039306

 XML example:

<?xml version="1.0" encoding="UTF-8"?>
<cx:locationFeatures xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:locationFeature>
    <cx:featureId>000000000001c393</cx:featureId>
    <cx:templateId>000000000001c38c</cx:templateId>
    <cx:locationId>c61c65d83a484d488fee5be5e634a276</cx:locationId>
    <cx:locationId>3b96979ae9f745c98268078d61e492f2</cx:locationId>
  </cx:locationFeature>
  <cx:locationFeature>
    <cx:featureId>000000000001c396</cx:featureId>
    <cx:templateId>000000000001c38c</cx:templateId>
    <cx:locationId>ccab6978a07e473ab4d7799b00c9368a</cx:locationId>
    <cx:locationId>f7d11fd4e0504ad58b980e4bacdf7784</cx:locationId>
  </cx:locationFeature>
  <cx:locationFeature>
    <cx:featureId>000000000001c397</cx:featureId>
    <cx:templateId>000000000001c38c</cx:templateId>
    <cx:locationId>f229d8164da3402dbec937ef556e39c1</cx:locationId>
    <cx:locationId>e56e86b10e3c46918e7341cb7f4d5a7b</cx:locationId>
  </cx:locationFeature>
</cx:locationFeatures>

Individual Location features

The POST, GET, PUT and DELETE operations are supported for management of individual Location features.

POST

Create a new Location feature under the Campaign or Ad with the given parentId.

https://{cxadbaseurl}/api/secure/locationFeature/{parentId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • parentId the id of either a Campaign or Ad under which the new Location feature is to be created

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X POST https://cxad.cxense.com/api/secure/locationFeature/0000000000039306 -d @input.xml

This XML example shows the contents required to be supplied for a POST call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:locationFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:templateId>000000000001c38c</cx:templateId>
  <cx:locationId>c61c65d83a484d488fee5be5e634a276</cx:locationId>
  <cx:locationId>3b96979ae9f745c98268078d61e492f2</cx:locationId>
</cx:locationFeature>

GET

Retrieve the Location feature with the given featureId

https://{cxadbaseurl}/api/secure/locationFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Location feature to be retrieved

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X GET https://cxad.cxense.com/api/secure/locationFeature/00000000000353f7

This XML example shows the contents returned from a GET call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:locationFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:featureId>000000000001c393</cx:featureId>
  <cx:templateId>000000000001c38c</cx:templateId>
  <cx:locationId>c61c65d83a484d488fee5be5e634a276</cx:locationId>
  <cx:locationId>3b96979ae9f745c98268078d61e492f2</cx:locationId>
</cx:locationFeature>

PUT

Update the Location feature with the given featureId

https://{cxadbaseurl}/api/secure/locationFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Location feature to be updated

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X PUT https://cxad.cxense.com/api/secure/locationFeature/00000000000353f7 -d @input.xml

This XML example shows the contents required to be supplied for a PUT call:

<?xml version="1.0" encoding="UTF-8"?>
<cx:locationFeature xmlns:cx="http://cxense.com/cxad/api/cxad">
  <cx:featureId>000000000001c393</cx:featureId>
  <cx:templateId>000000000001c38c</cx:templateId>
  <cx:locationId>c61c65d83a484d488fee5be5e634a276</cx:locationId>
  <cx:locationId>3b96979ae9f745c98268078d61e492f2</cx:locationId>
</cx:locationFeature>

DELETE

Delete the Location feature with the given featureId

https://{cxadbaseurl}/api/secure/locationFeature/{featureId}

Parameters:

  • cxadbaseurl the base URL of the Cxense Advertising system

  • featureId the id of the Location feature to be deleted

Example command:

curl -s -H "Content-type: text/xml" -u jsmith123:password1 -X DELETE https://cxad.cxense.com/api/secure/locationFeature/00000000000353f7


Last updated: