Skip to main content
Skip table of contents

GetHtmlList

Description

Returns array of Html Items filtered by input parameters. When any of the parameters is missed, then the default value is used.

Input Parameters

Parameter

Description

apiKey (string)

To use the Q4 API, you need to have an application key. We use this to track API usage. Currently, the use of the API is allowed only with prior permission. Requests for API keys are reviewed by staff. Please get in touch with support to get the API Key.

languageId (int)

Specifies the language for which financial reports should be returned. The default value is 1 (English).

tagList (string)

If specified, the result will be filtered by tags. Tags are pipe-delimited - 'tag1|tag2'. The default is an empty string.

pageNumber (int)

When paging is used, this specifies the page number to return. It is 0-based.

pageSize (int)

When pageSize is greater the 0, the paging is enabled. The default is 0 (paging disabled).

includeTags (bool)

Specifies that returned data records have to include associated tags. The default is false.

Sample URL

https://www.domain.com/feed/Html.svc/GetHtmlList?callback=jQuery171009535868121644664_1344438749331&apiKey=XXXXXXXXXXXXXXXXX&languageId=1&tagList=en&pageNumber=0&pageSize=20&includeTags=true&_=1344439303906

Sample Request

JSON
var data = {
    apiKey: apiKey,
    languageId: 1,
    tagList: 'en',
    pageNumber: 0,
    pageSize: 20,
    includeTags: true
};

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/Html.svc/GetHtmlList",
    data: data,
    contentType: "application/json; charset=utf-8",
    dataType: "jsonp",
    success: OnLoadHtmlListSuccess,
    error: OnLoadError
});

Sample Response

JSON
{
    "GetHtmlListResult": [{
            "Html": "<p style=\"margin: 0px 0px 10px; padding: 0px; list-style-type: none; font-size: 15px; line-height: 24px; color: #000000; font-family: arial, verdana, helvetica, sans-serif;\">A short, <a href=\"http://bit.ly/MqkPv2\" target=\"_blank\" style=\"margin: 0px; padding: 0px; list-style-type: none; color: #1c609f; clear: none;\">low resolution video captured the final</a> minutes of Mars rover Curiosity's descent onto the planet. At the beginning of the clip the 15-foot wide heat shield can be seen separating from the capsule carrying the rover.</p>\r\n<p style=\"margin: 0px 0px 10px; padding: 0px; list-style-type: none; font-size: 15px; line-height: 24px; color: #000000; font-family: arial, verdana, helvetica, sans-serif;\">The images were recorded by the Mars Descent Imager, or MARDI, and pieced together at four frames per second to detail the final two and a half minutes of the rover's descent. According to NASA, the images needed to be reduced by a factor of eight in order for them to be sent back to Earth quickly. Higher resolution images (1600 by 1200) will be beamed to Earth in the coming months.</p>\r\n<p style=\"margin: 0px 0px 10px; padding: 0px; list-style-type: none; font-size: 15px; line-height: 24px; color: #000000; font-family: arial, verdana, helvetica, sans-serif;\">During the descent the passing Mars Reconnaissance Orbiter <a href=\"http://1.usa.gov/Mqkxoc\" target=\"_blank\" style=\"margin: 0px; padding: 0px; list-style-type: none; color: #1c609f; clear: none;\">snapped a shot of the rover's</a>supersonic parachute, which was designed to slow it from 900 miles per hour to around 200 miles per hour. The separated heat shield can be seen falling towards the surface.</p>\r\n<p style=\"margin: 0px 0px 10px; padding: 0px; list-style-type: none; font-size: 15px; line-height: 24px; color: #000000; font-family: arial, verdana, helvetica, sans-serif;\">The rover also sent <a href=\"http://1.usa.gov/Mqls8a\" target=\"_blank\" style=\"margin: 0px; padding: 0px; list-style-type: none; color: #1c609f; clear: none;\">a picture that shows the north wall and rim of Gale Crater</a>, the section of the planet where Curiosity touched down. The image is murky because the dust cover on the Mars Hand Lens Imager (MAHLI) hasn't been removed. During the descent, dust kicked up by the Sky Crane's rockets coated the lens, but the protective cover will be removed in the coming weeks. MAHLI's main purpose is to capture close-ups of rocks and soil -- it can focus as close as 2.1 centimeters -- but can also focus to infinity, allowing it to capture images like the one of the Martian landscape.</p>\r\n<p style=\"margin: 0px 0px 10px; padding: 0px; list-style-type: none; font-size: 15px; line-height: 24px; color: #000000; font-family: arial, verdana, helvetica, sans-serif;\">Curiosity's mission on Mars will last about two years and as NASA scientists enable more of the rover's imaging systems, higher resolution photos are expected in the coming days.</p>",
            "HtmlId": 13660,
            "LanguageId": 1,
            "RevisionNumber": 66510,
            "TagsList": ["en",
                "Mars",
                "Curiosity"
            ],
            "WorkflowId": "d12a809d-52a9-4f6c-b215-bf01edcc180d",
            "ModuleTitle": "TestHtmlModule",
            "SectionUrl": "http://SomeFriendlyUrl/default.aspx"
        },
        {
            "Html": "<p style=\"padding: 0px; margin: 0px 0px 0.83em; font-size: 16px; line-height: 1.5em; font-family: georgia, 'times new roman', times, serif;\">Toronto’s sizzling condo market has peaked, and developers are just waiting to see where the roller coaster goes next, says a housing research firm.</p>\r\n<p style=\"padding: 0px; margin: 0px 0px 0.83em; font-size: 16px; line-height: 1.5em; font-family: georgia, 'times new roman', times, serif;\">“We have hit the peak in the new condo market, we are on the down side of the roller coaster,” Ben Myers, executive vice president of Urbanation Inc., said in a phone interview. “We will really have to see how the developers react to a little bit of the slowing in the market, if they hold off on new launches.”</p>\r\n<p style=\"padding: 0px; margin: 0px 0px 0.83em; font-size: 16px; line-height: 1.5em; font-family: georgia, 'times new roman', times, serif;\">Canada’s biggest city is being transformed by a wave of new condos as low interest rates and a stable economy draw investors and individual buyers to downtown projects. Finance Minister Flaherty tightened mortgage lending rules in June and criticized “continuous building, without restriction” of condos while the central bank says record consumer debt and the chance of a sudden housing correction are major risks to the economy.</p>",
            "HtmlId": 13662,
            "LanguageId": 1,
            "RevisionNumber": 66518,
            "TagsList": ["en",
                "condo"
            ],
            "WorkflowId": "25fcdd5d-5089-4378-a0a3-affcf6f96b5b",
            "ModuleTitle": "TestHtmlModule",
            "SectionUrl": "http://SomeFriendlyUrl/default.aspx"
        }
    ]
} 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.