Ad Rotators

    List all ad rotators

    Get all the ad rotators of a site.

    Request

    • Method: GET
    • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

      Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
      • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
    • Path: /webresources/api/v3/sites/current/adrotators
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response body

    An array of the first 10 items; each object has the following properties:

    • id - ad rotator ID (number)
    • siteId - site ID (number)
    • name - ad rotator's name (string)
    • createDate - ad rotator's creation date (dateTime)
    • lastUpdateDate - ad rotator's last update date (dateTime)
    • enabled - enabled (boolean)

    You can output additional fields to those listed above as default, see the API v3 Discovery APP for additional details.

    Accepts and returns JSON as Content-Type.


    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/adrotators",
        type: "GET",
        connection: "keep-alive",    
        contentType: "application/json",
        headers: {
            "Authorization": $.cookie('access_token')
        }
    });
    request.done(function (msg) {
        console.log(msg);
    });
    request.fail(function (jqXHR) {
        console.log("Request failed.");
        console.log("Error code: " + jqXHR.status);
        console.log("Error text: " + jqXHR.statusText);
        console.log("Response text: " + jqXHR.responseText);
    });

    Sample response

    {
      "items": [
        {
          "id": 4994,
          "siteId": 1767665,
          "name": "My Ad Rotator",
          "createDate": "2016-03-15T12:34:04.807",
          "lastUpdateDate": "2016-03-15T12:36:58.14",
          "enabled": true
        },
        {
          "id": 4995,
          "siteId": 1767665,
          "name": "My Second Empty Rotator",
          "createDate": "2016-03-15T12:38:57.59",
          "lastUpdateDate": "2016-03-15T12:38:57.59",
          "enabled": true
        }
      ],
      "totalItemsCount": 2,
      "skip": 0,
      "limit": 10
    }

    Get an ad rotator's details

    Get an ad rotator and it's details.

    Request

    • Method: GET
    • Version: v3, this API call supports additional sort and filter mechanisms as well as retrieving only a sub-set of fields

      Note: In order to access the v3 API endpoints please make sure you have enabled the new rendering engine.

    • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
      • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
    • Path: /webresources/api/v3/sites/current/adrotators/[adrotator_ID]
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    Displays the details for the ad rotator as a JSON object

    • id - ad rotator ID (number)
    • siteId - site ID (number)
    • name - ad rotator's name (string)
    • createDate - product's creation date (dateTime)
    • lastUpdateDate - product's last update date (dateTime)
    • enabled - enabled (boolean)

    Accepts and returns JSON as Content-Type.


    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/adrotators/4994",
        type: "GET",
        connection: "keep-alive",    
        contentType: "application/json",
        headers: {
            "Authorization": $.cookie('access_token')
        }
    });
    request.done(function (msg) {
        console.log(msg);
    })
    request.fail(function (jqXHR) {
        console.log("Request failed.");
        console.log("Error code: " + jqXHR.status);
        console.log("Error text: " + jqXHR.statusText);
        console.log("Response text: " + jqXHR.responseText);
    })

    Sample response

    {
      "id": 4994,
      "siteId": 1767665,
      "name": "My Ad Rotator",
      "createDate": "2016-03-15T12:34:04.807",
      "lastUpdateDate": "2016-03-15T12:36:58.14",
      "enabled": true
    }