Product RSS Channels

    List all RSS channels of a product

    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/products/[product_ID]/rsschannels
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

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

    • objectId - the tag's ID (numeric)
    • rssChannelId - the site's ID (numeric)
    • objectType - the site's ID (numeric)
    • displayable - if should be displayed (1) if not (0) (numeric)
    • siteId - the site's ID (numeric)
    • deleted - (boolean)
    • rssChannel - the rss channel object (object)

    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/products/951888/rsschannels",
        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": [
        {
          "objectId": 951888,
          "rssChannelId": 4096,
          "objectType": 27,
          "displayable": 1,
          "siteId": 38581,
          "deleted": false,
          "rssChannel": {
            "Id": 4096,
            "siteId": 38581,
            "title": "test",
            "description": "",
            "maxFeedEntries": 15,
            "createBy": 54273,
            "createDate": "2015-07-15T13:59:24.417",
            "lastUpdateBy": 54273,
            "lastUpdateDate": "2015-07-15T13:59:24.417",
            "enabled": true
          }
        }
      "totalItemsCount": 1,
      "skip": 0,
      "limit": 10
    }

    Add an existing RSS channel to a product

    Request

    • Method: POST
    • 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/products/[product_ID]/rsschannels
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Parameters

    • tagId - the tag's ID (numeric)

    Response

    Returns an empty body if successful or a detailed error message.

    Accepts and returns JSON as Content-Type.

    Response:

    HTTP/1.1 204 No Content

    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/products/951888/rsschannels",
        type: "POST",
        connection: "keep-alive",    
    	contentType: "application/json",headers: {
            "Authorization": $.cookie('access_token')
        },
        processData: false,
        data: JSON.stringify({
            "items": [
            {	"rssChannelId": 4096
            }]
        })
    });
    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);
    })

    Remove RSS channel from product

    Request

    • Method: DELETE
    • 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/products/[product_ID]/rsschannels?items=[{"rssChannelId":[rss_channel_ID1]},{"rssChannelId":[rss_channel_ID2]}]
      • Alternatively, use siteID instead of 'current'
    • Authorization header: This should contain the authorization token. Here is how to obtain the token.

    Response

    Returns an empty body if successful or a detailed error message.


    Request:

    DELETE /webresources/api/v3/sites/current/products/951888/rsschannels?items=[{"rssChannelId":4096}] HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json
    

    Response:

    HTTP/1.1 204 NO CONTENT

    Sample request

    var access_token = BCAPI.Helper.Site.getAccessToken();
    
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/products/951888/rsschannels?items=[{"rssChannelId":4096},{"tagId":4097}]",
        type: "DELETE
        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);
    })