GetLookupList

Description

Returns array of Lookup Item 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).
`lookupType` (string)	If specified, the result will be filtered by the lookup type. The default is an empty string.

Sample URL

https://www.domain.com/feed/Lookup.svc/GetLookupList?apiKey=c34993dcba1942418d97656f3ed00979&languageId=1&lookupType=indices

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    lookupType: 'indices'
};

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

Sample Response

JSON

{
    "GetLookupListResult": [{
            "Type": "indices",
            "Text": "TSX, AEM (Canadian Dollar)",
            "Value": "TSE:AEM.CA",
            "WorkflowID": "d7958bd8-ab48-4a6c-8d74-a1854bccd852",
            "RevisionNumber": 1,
            "LanguageID": 1
        },
        {
            "Type": "indices",
            "Text": "TSX, AEM.WT.U",
            "Value": "TSE:AEM.WTU.CA",
            "WorkflowID": "d230f86f-db81-4441-b81d-33396414b574",
            "RevisionNumber": 1,
            "LanguageID": 1
        },
        {
            "Type": "indices",
            "Text": "NYSE, AEM (US Dollar)",
            "Value": "NYSE",
            "WorkflowID": "8318754b-ddaf-48e9-8fe5-9735dc3d9914",
            "RevisionNumber": 1,
            "LanguageID": 1
        },
        {
            "Type": "indices",
            "Text": "NYSE:AEM",
            "Value": "NYSE:AEM",
            "WorkflowID": "21dbc89a-244a-4b01-82e8-44e2f01d58c1",
            "RevisionNumber": 1,
            "LanguageID": 1
        }
    ]
}