GetPeopleList

Description

Returns array of Persons 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).
`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).
`departmentId` (Guid)	Specifies the id of the department by which persons need to be filtered, the default value is "00000000-0000-0000-000000000000".

Sample URL

https://www.domain.com/feed/People.svc/GetPeopleList?apiKey=BC0F9D590DE14126A1C8C175F91CFE59&languageId=1&pageNumber=0&pageSize=5&departmentId=c8244d44-ab48-4532-86fe-0c2e2c898740

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    pageNumber: 0,
    pageSize: 10,
    departmentId: departmentId
}

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/People.svc/GetPeopleList",
    data: data,
    dataType: "jsonp",
    success: OnLoadPeopleSuccess,
    error: OnLoadError
});

Sample Response

JSON

{
    "GetPeopleListResult": [{
        "CareerHighlight": "",
        "DepartmentId": "c8244d44-ab48-4532-86fe-0c2e2c898740",
        "Description": "Mr. Wiswell earned his B.A. 1971 and LLB (Law) 1974 degrees from the University of Manitoba. He practiced corporate and commercial law, completed an MBA at the University of Western Ontario in 1980 and joined Gulf Canada Resources Limited. He spent 16 years at Gulf Canada, which included key roles as Vice President Marketing, Oil Sands and Frontiers and Senior Vice President Finance and Chief Financial Officer. As CFO, Mr. Wiswell was actively involved in corporate strategy, equity and debt financings, acquisitions and divestments, investor relations and organizational restructuring and change.<br><br>\r\nAfter his tenure at Gulf, Mr. Wiswell joined ICG Propane as President, where he revitalized the business leading to the sale of the company to Superior Propane. In December 2001, he joined Parkland Industries Ltd. as President and CEO. At Parkland, he led Parkland's conversion to an income trust in June 2002, completed restructuring and enhancement of the company's performance, and delivered strong value creation for investors. In May 2005, Mr. Wiswell joined NAL as President & CEO and has led the process of change in people, assets and opportunities to position NAL for conversion to a dividend paying E&P corporation on December 31, 2010. From April 2009 to March 2010, Mr. Wiswell served as Chairman of the Board of Governors of the Canadian Association of Petroleum Producers (CAPP).",
        "FirstName": "Andrew",
        "HighResolutionPhotoPath": null,
        "LanguageId": 1,
        "LastName": "B. Wiswell",
        "LowResolutionPhotoPath": "http://www.domain.com/Theme/NAL/files/Images/holly-and-Kathie.jpg",
        "MiddleName": "",
        "PersonId": 100,
        "PhotoPath": "http:// www.domain.com/Theme/NAL/files/Images/air.jpg",
        "Prefix": " --- Select ---",
        "Quote": "",
        "Rank": 3,
        "RevisionNumber": 5876,
        "Suffix": "",
        "ThumbnailPath": "http:// www.domain.com/Theme/NAL/files/Images/Executive/Andy10.jpg",
        "Title": "– President & CEO",
        "WorkflowId": "2c7d10f1-f933-44a3-b436-5ecc0f561e5f"
    }]
}