GetPresentationList

Description

Returns array of Presentations 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 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, 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.
`presentationDateFilter` (PresentationDateFilter)	Specifies the range in dates of presentations that need to be returned. The default value is 0 (Future).
`startDate` (DateTime)	When `presentationDateFilter` = 2 (DateRange), specifies the lower date bound. No default value - always has to be specified.
`endDate` (DateTime)	When `presentationDateFilter` = 2 (DateRange), specifies the upper date bound. No default value - always has to be specified.
`year` (Types)	Specifies the year for which financial reports should be returned. When it is not provided, the result will not be filtered by year.

Sample URL

https://www.domain.com/feed/Presentation.svc/GetPresentationList?apiKey=c34993dcba1942418d97656f3ed00979&languageId=1&pageNumber=0&pageSize=20&presentationDateFilter=3&year=2011

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    tagList: 'Q1|Q2',
    pageNumber: 0,
    pageSize: 20,
    presentationDateFilter: 3,
    year: 2011
}

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

Sample Response

JSON

{
    "GetPresentationListResult": [{
            "AudioFile": "",
            "AudioFileSize": null,
            "AudioFileType": null,
            "Body": "",
            "DocumentFileSize": null,
            "DocumentFileType": null,
            "DocumentPath": "http:\/\/localhost\/Theme\/Agnico2\/files\/2011-04-28_Q1_2011 Results Final.pdf",
            "ExcludeFromLatest": false,
            "LanguageId": 1,
            "LinkToDetailPage": "\/English\/Investor-Centre\/Presentations\/2011\/Q12011ResultsPresentation\/default.aspx",
            "LinkToUrl": "",
            "PresentationDate": "\/Date(1304017200000-0500)\/",
            "PresentationId": 1549,
            "PresentationSpeaker": [

            ],
            "RelatedFile": "",
            "RelatedFileSize": null,
            "RelatedFileType": null,
            "RevisionNumber": 58542,
            "SeoName": "Q12011ResultsPresentation",
            "TagsList": [
                "q12011"
            ],
            "ThumbnailPath": "",
            "Title": "Q1 Results Presentation",
            "VideoFile": "",
            "VideoFileSize": null,
            "VideoFileType": null,
            "WorkflowId": "5f776a3b-be36-4c23-9601-5b6d4870b358"
        },
        {
            "AudioFile": "http:\/\/localhost\/Theme\/Agnico2\/files\/photos\/Blue hills.jpg",
            "AudioFileSize": "27 KB",
            "AudioFileType": "JPG",
            "Body": "",
            "DocumentFileSize": "70 KB",
            "DocumentFileType": "PDF",
            "DocumentPath": "http:\/\/localhost\/Theme\/Agnico2\/files\/FinancialReports\/AEM-Q12008Report.pdf",
            "ExcludeFromLatest": false,
            "LanguageId": 1,
            "LinkToDetailPage": "\/English\/Investor-Centre\/Presentations\/2011\/AEM-Corporate-UpdateMarch2011\/default.aspx",
            "LinkToUrl": "",
            "PresentationDate": "\/Date(1301511600000-0500)\/",
            "PresentationId": 1550,
            "PresentationSpeaker": [{
                "EventSpeakerId": 0,
                "PresentationId": 1550,
                "PresentationSpeakerId": 218,
                "SpeakerName": "Ammar Al-Joundi",
                "SpeakerPosition": "Senior Vice-President Finance and CFO"
            }],
            "RelatedFile": "http:\/\/localhost\/Theme\/Agnico2\/files\/AEM Factsheet Aug 2007 FR ver2.pdf",
            "RelatedFileSize": "2.12 MB",
            "RelatedFileType": "PDF",
            "RevisionNumber": 59222,
            "SeoName": "AEM-Corporate-UpdateMarch2011",
            "TagsList": [
                "Q1",
                "Q2"
            ],
            "ThumbnailPath": "http:\/\/localhost\/Theme\/Agnico2\/files\/design\/add_left_pane.gif",
            "Title": "AEM Corporate Update - March 2011",
            "VideoFile": "http:\/\/localhost\/Theme\/Agnico2\/files\/design\/HomeSlide\/active_slider.png",
            "VideoFileSize": "0 KB",
            "VideoFileType": "PNG",
            "WorkflowId": "76882266-85a2-41f0-9972-749ca1841d3e"
        }
    ]
}