RSS

    List all RSS channels

    Gets the list of RSS resources available.

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

    Response

    The details for the specified customer ID in JSON format.

    • Id - the id of the RSS channel(integer)
    • siteId - the id of the site (integer)
    • title - the RSS channel's name(integer)
    • description - the RSS channel's description (integer)
    • maxFeedEntries - the update frequency of the channel (integer)
      • 15 - Several times a week
      • 30 - Once a day
      • 50 - Many times a day
      • 100 - Wildfire!
    • createBy - the id of the entity that created the channel (number)
    • createDate - the name of the customer Type (dateTime)
    • lastUpdateBy - the id of the entity that did the last modification (number)
    • lastUpdateDate - the name of the customer Type (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.


    Request:

    GET /webresources/api/v3/sites/current/rsschannels HTTPS/1.1
    Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
    Connection: keep-alive
    Content-Type: application/json

    Response:

    {
      "items": [
        {
          "Id": 13412,
          "siteId": 1767665,
          "title": "First Channel",
          "description": "This is a test channel",
          "maxFeedEntries": 15,
          "createBy": 1059477,
          "createDate": "2016-03-14T17:10:25.573",
          "lastUpdateBy": 1059477,
          "lastUpdateDate": "2016-03-14T17:10:25.573",
          "enabled": true
        },
        {
          "Id": 13425,
          "siteId": 1767665,
          "title": "Second Channel",
          "description": "This is a test channel",
          "maxFeedEntries": 100,
          "createBy": 1059477,
          "createDate": "2016-03-15T15:16:19.407",
          "lastUpdateBy": 1059477,
          "lastUpdateDate": "2016-03-15T15:16:19.407",
          "enabled": true
        }
      ],
      "totalItemsCount": 2,
      "skip": 0,
      "limit": 10
    }

    Sample code

    var access_token = BCAPI.Helper.Site.getAccessToken();
    
    var request = $.ajax({
        url: "/webresources/api/v3/sites/current/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);
    });

    Get a RSS channel

    Get details of one RSS channel.

    Request

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

    Parameters

    • Id - the id of the RSS channel(integer)
    • siteId - the id of the site (integer)
    • title - the RSS channel's name(integer)
    • description - the RSS channel's description (integer)
    • maxFeedEntries - the update frequency of the channel (integer)
      • 15 - Several times a week
      • 30 - Once a day
      • 50 - Many times a day
      • 100 - Wildfire!
    • createBy - the id of the entity that created the channel (number)
    • createDate - the name of the customer Type (dateTime)
    • lastUpdateBy - the id of the entity that did the last modification (number)
    • lastUpdateDate - the name of the customer Type (dateTime)
    • enabled - enabled (boolean)

    Response

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

    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/rsschannels/287045",
        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);
    })

    Response:

    {
      "Id": 13412,
      "siteId": 1767665,
      "title": "First Channel",
      "description": "This is a test channel",
      "maxFeedEntries": 15,
      "createBy": 1059477,
      "createDate": "2016-03-14T17:10:25.573",
      "lastUpdateBy": 1059477,
      "lastUpdateDate": "2016-03-14T17:10:25.573",
      "enabled": true
    }