GetEventList

Description

Returns array of Events 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.
`eventDateFilter` (EventDateFilter)	Specifies the range in dates of events that need to be returned. The default value is 0 (Past).
`eventTypeFilter` (EventTypeFilter)	Specifies the type of events that need to be returned. The default value is 0 (All).
`startDate` (DateTime)	When `eventSelection` = 2 (DateRange), specifies the lower date bound. No default value - always has to be specified.
`endDate` (DateTime)	When `eventSelection` = 2 (DateRange), specifies the upper date bound. No default value - always has to be specified.
`sortOperator` (int)	Specifies how events will be sorted by date. The default value is 0 (Ascending).
`year` (int)	Specifies the year for which events should be returned. When not used, -1 must be passed. The default value is 0.
`buffer` (int)	When `eventSelection` is 1 (Future), specifies the number of hours before the end date the event should be returned. Default is 0 (till the event end date, the event is considered a Future event).
`includePressReleases` (bool)	Specifies if related Press Release needs to be returned with each event. The default is false.
`includePresentations` (Types)	Specifies if related Presentations array needs to be returned with each event. The default is false.
`includeFinancialReports` (bool)	Specifies if the related financial report needs to be returned with each event. The default is false.
`excludeSelection` (ExcludeSelection)	When 0 is passed, events marked as 'Exclude from latest' will not be returned. Default value is 0 (`ExcludeLatest`).

Sample URL

https://www.domain.com/feed/Event.svc/GetEventList?apiKey=866A739E38D044FCBA9307744E58612C&languageId=1&pageSize=10&startDate=2013%2F08%2F26&endDate=2014%2F12%2F31&buffer=0&includePressReleases=true&includePresentations=true&includeFinancialReports=true&eventDateFilter=2

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    tagList: 'Q1|Q2',
    pageNumber: 0,
    pageSize: 20,
    eventDateFilter: 3,
    eventTypeFilter: 0,
    year: 2011,
    sortOperator: 1,
    buffer: 0,
    includePressReleases: true,
    includePresentations: true,
    includeFinancialReports: true
}

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

Sample Response

JSON

{
    "GetEventListResult": [{
            "Attachments": [

            ],
            "Body": "- Toronto",
            "DocumentFileSize": null,
            "DocumentFileType": null,
            "DocumentPath": "",
            "EndDate": "09\/12\/2013 12:00:00",
            "EventFinancialReport": [
                null
            ],
            "EventId": 1163,
            "EventPresentation": [

            ],
            "EventPressRelease": [
                null
            ],
            "EventSpeaker": [

            ],
            "ExcludeFromLatest": false,
            "FinancialReportWorkflowId": "00000000-0000-0000-0000-000000000000",
            "IsWebcast": false,
            "LanguageId": 1,
            "LinkToDetailPage": "\/investors\/presentations\/presentation-details\/2013\/2013-BAML-canada-mining\/default.aspx",
            "LinkToUrl": "",
            "Location": "",
            "PressReleaseWorkflowId": "00000000-0000-0000-0000-000000000000",
            "ReportQuarter": "First Quarter",
            "ReportYear": "2004",
            "ProjectWorkflowId": "00000000-0000-0000-0000-000000000000",
            "RevisionNumber": 65962,
            "SeoName": "2013-BAML-canada-mining",
            "StartDate": "09\/12\/2013 11:30:00",
            "TagsList": null,
            "TimeZone": "EDT",
            "Title": "Bank of America Merrill Lynch Canada Mining Conference",
            "WebCastLink": "",
            "WorkflowId": "60544cd6-ab4f-4a21-8a3e-e96e00f2a525"
        },
        {
            "Attachments": [{
                    "DocumentType": "file",
                    "Extension": "JPG",
                    "Size": "360 KB",
                    "Title": "View Document",
                    "Type": "Document",
                    "Url": "http:\/\/www.domain.com\/files\/annual-report-2012\/alto-chicama.jpg"
                },
                {
                    "DocumentType": "file",
                    "Extension": "JPG",
                    "Size": "130 KB",
                    "Title": "View presentation",
                    "Type": "Presentation",
                    "Url": "http:\/\/www.domain.com\/files\/reko-diq\/01-cover.jpg"
                },
                {
                    "DocumentType": "online",
                    "Extension": null,
                    "Size": "",
                    "Title": "Check online video",
                    "Type": "Video",
                    "Url": "http:\/\/yourtube\/video"
                }
            ],
            "Body": "",
            "DocumentFileSize": null,
            "DocumentFileType": null,
            "DocumentPath": "",
            "EndDate": "09\/24\/2013 10:40:00",
            "EventFinancialReport": [{
                "CoverImagePath": "",
                "Documents": [{
                    "DocumentCategory": "Financial Report",
                    "DocumentFileSize": null,
                    "DocumentFileType": null,
                    "DocumentId": 7169,
                    "DocumentOrder": 999,
                    "DocumentPath": "http:\/\/www.domain.com\/files\/quarterly-reports\/2013\/Barrick-2013-Second-Quarter-Report.pdf",
                    "DocumentTitle": "2013 Second Quarter Report",
                    "DocumentType": "File",
                    "IconPath": null,
                    "LanguageId": 1,
                    "ReportWorkflowId": "8bd9386d-2f3b-456f-8ec4-4f3335ae0bb8",
                    "RevisionNumber": 65490,
                    "ThumbnailPath": "http:\/\/www.domain.com\/files\/quarterly-reports\/2013\/Barrick-2013-Second-Quarter-Report.png",
                    "WorkflowId": "936732ec-9f4b-4de4-ac35-da9742554b99"
                }],
                "LanguageId": 1,
                "ReportDate": "08\/01\/2013 00:00:00",
                "ReportId": 2602,
                "ReportOrder": 77,
                "ReportSubType": "Second Quarter",
                "ReportTitle": "Second Quarter 2013",
                "ReportYear": 2013,
                "RevisionNumber": 65491,
                "TagsList": [

                ],
                "WorkflowId": "8bd9386d-2f3b-456f-8ec4-4f3335ae0bb8"
            }],
            "EventId": 1167,
            "EventPresentation": [

            ],
            "EventPressRelease": [{
                "Body": null,
                "Category": "NA",
                "DocumentFileSize": null,
                "DocumentFileType": null,
                "DocumentPath": "",
                "ExcludeFromLatest": false,
                "Headline": "Barrick Reports Second Quarter 2013 Results",
                "LanguageId": 1,
                "LinkToDetailPage": "\/investors\/news\/news-details\/2013\/Barrick-Reports-Second-Quarter-2013-Results\/default.aspx",
                "LinkToPage": "00000000-0000-0000-0000-000000000000",
                "LinkToUrl": "",
                "MediaCollection": [

                ],
                "PressReleaseDate": "08\/01\/2013 06:30:00",
                "PressReleaseId": 2320,
                "ProjectWorkflowId": "00000000-0000-0000-0000-000000000000",
                "RevisionNumber": 65529,
                "SeoName": "Barrick-Reports-Second-Quarter-2013-Results",
                "ShortBody": "$8.7 billion in after-tax impairment charges, largely driven by recent declines in metal prices Strong operating results from gold and copper mines; 2013 production guidance maintained, cost guidance for both gold and copper lowered Reduced 2013 budgeted capital and costs by about $1.5 billion during the second quarter and by about $2.0 billion in H1 2013 2013 capital guidance reduced to",
                "ShortDescription": "",
                "TagsList": [

                ],
                "ThumbnailPath": "",
                "WorkflowId": "0414a55f-4e66-4e7c-8481-8ea19d40b04b"
            }],
            "EventSpeaker": [

            ],
            "ExcludeFromLatest": false,
            "FinancialReportWorkflowId": "8bd9386d-2f3b-456f-8ec4-4f3335ae0bb8",
            "IsWebcast": false,
            "LanguageId": 1,
            "LinkToDetailPage": "\/investors\/presentations\/presentation-details\/2013\/2013-Denver-Gold-Forum\/default.aspx",
            "LinkToUrl": "",
            "Location": "",
            "PressReleaseWorkflowId": "0414a55f-4e66-4e7c-8481-8ea19d40b04b",
            "ProjectWorkflowId": "00000000-0000-0000-0000-000000000000",
            "ReportQuarter": "",
            "ReportYear": "",
            "RevisionNumber": 66025,
            "SeoName": "2013-Denver-Gold-Forum",
            "StartDate": "09\/24\/2013 10:15:00",
            "TagsList": null,
            "TimeZone": "MDT",
            "Title": "Denver Gold Forum",
            "WebCastLink": "",
            "WorkflowId": "4819ff3b-eb57-46c5-abeb-8ceab7efaf46"
        }
    ]
}