GetPressReleaseList

Description

Returns array of Press Releases filtered by input parameters. When any parameters are missed, 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 press releases 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, specify 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.
`year` (int)	Specifies the year for which press releases should be returned. When it is not provided, the result will not be filtered by year.
`pressReleaseDateFilter` (PressReleaseDateFilter)	Specifies the range in dates of press releases that need to be returned. The default value is 0 (Past).
`categoryId` (Guid)	Specifies the id of the category by which press releases need to be filtered. The default value is "00000000-0000-0000-0000-000000000000".
`bodyType` (PressReleaseBodyType)	Specifies how the press release body needs to be returned. The default value is 0 (IncludeNoBody).
`startDate` (DateTime)	When `pressReleaseDateFilter` = 2 (DateRange), specifies the lower date bound. The default value is "0001/01/01 00:00:00".
`endDate` (DateTime)	When `pressReleaseDateFilter` = 2 (DateRange), specifies the upper date bound. The default value is "0001/01/01 00:00:00".

Sample URL

https://www.domain.com/feed/PressRelease.svc/GetPressReleaseList?apiKey=c34993dcba1942418d97656f3ed00979&tagList=tag1|tag2&pageNumber=3&pageSize=20&includeTags=true&year=2010&pressReleaseDateFilter=3&bodyType=3&startDate=2010/01/01&endDate2010/12/31 06:00:00

Sample Request

JSON

var data = {
    apiKey: 'c34993dcba1942418d97656f3ed00979',
    tagList: "tag1|tag2",
    pageNumber: 3,
    pageSize: 20,
    includeTags: true,
    pressReleaseDateFilter: 2,
    bodyType: 3,
    startDate: "2010/01/01",
    endDate: "2010/12/31 06:00:00"
};

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/PressRelease.svc/GetPressReleaseList",
    data: data,
    dataType: "json",
    success: OnLoadPressReleaseListSuccess,
    error: OnLoadError
});

Sample Response

JSON

{
    "GetPressReleaseListResult": [{
            "Body": null,
            "Category": "",
            "DocumentFileSize": null,
            "DocumentFileType": null,
            "DocumentPath": null,
            "ExcludeFromLatest": false,
            "Headline": "AGNICO-EAGLE PROVIDES UPDATE ON ITS 2010 EXPLORATION PROGRAM; RECORD EXPLORATION BUDGET OF $145 MILLION FOR 2011",
            "LanguageId": 1,
            "LinkToDetailPage": "/English/Investor-Centre/PressReleases/Details/2010/PROVIDES-UPDATE-ON-ITS-2010-EXPLORATION-PROGRAM-RECORD-EXPLORATION-BUDGET-OF-145-MILLION-FOR-20111123558/default.aspx",
            "LinkToUrl": "",
            MediaCollection: [{
                Alt: "Some description",
                Height: 218,
                SourceUrl: "http://domain.com/files/PRImages/2011/Q4/kittila--composite-longitudinal-section_v001_s15k1tThumbnail.jpg",
                Style: "border:0px none -moz-use-text-color; width: 263px; height: 213px;",
                Width: 457
            }],
            "PressReleaseDate": "/Date(1292467320000-0600)/",
            "PressReleaseId": 2720,
            "ProjectWorkflowId": "00000000-0000-0000-0000-000000000000",
            "RevisionNumber": 57383,
            "SeoName": "UPDATE-ON-ITS-2010-EXPLORATION-PROGRAM-RECORD-EXPLORATION-BUDGET-OF-145-MILLION-FOR-20111123558",
            "ShortBody": "",
            "ShortDescription": "",
            "TagsList": [
                "tag1"
            ],
            "ThumbnailPath": "http://www.domain.com/images/thumb.jpg",
            "WorkflowId": "c9b727e9-8344-4264-89e0-338768d1fb44"
        },
        {
            "Body": null,
            "Category": "",
            "DocumentFileSize": "127KB",
            "DocumentFileType": "pdf",
            "DocumentPath": "http://www.domain.com/Theme/files/2010-12-15_Dividend_Guidance_Final.pdf",
            "ExcludeFromLatest": false,
            "Headline": "AGNICO-EAGLE RELEASES ANNUAL PRODUCTION GROWTH PLAN; 2011 CASH DIVIDEND INCREASED BY 256%",
            "LanguageId": 1,
            "LinkToDetailPage": "/English/Investor-Centre/PressReleases/Details/2010/RELEASES-ANNUAL-PRODUCTION-GROWTH-PLAN-2011-CASH-DIVIDEND-INCREASED-BY-2561123556/default.aspx",
            "LinkToUrl": "",
            "MediaCollection": [{
                Alt: "",
                Height: null,
                SourceUrl: "http://agnico.q4.local/files/PRImages/2011/Q4/creston-mascota_v001_i4b2t0Thumbnail.jpg",
                Style: "border:0px none -moz-use-text-color;",
                Width: null
            }],
            "PressReleaseDate": "/Date(1292454000000-0600)/",
            "PressReleaseId": 2698,
            "ProjectWorkflowId": "00000000-0000-0000-0000-000000000000",
            "RevisionNumber": 54546,
            "SeoName": "RELEASES-ANNUAL-PRODUCTION-GROWTH-PLAN-2011-CASH-DIVIDEND-INCREASED-BY-2561123556",
            "ShortBody": null,
            "ShortDescription": "",
            "TagsList": [
                "tag1", "tag2"
            ],
            "ThumbnailPath": "",
            "WorkflowId": "1fa60cff-9d59-4486-ae2f-73bbf1574d99"
        }
    ]
}