apo-wsapi2 v1.0.0

Getting started

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder APILib in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha APIController to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

API client can be initialized as following:

const lib = require('lib');

Class Reference

List of Controllers

• APIController

APIController

Get singleton instance

The singleton instance of the APIController class can be accessed from the API Client.

var controller = lib.APIController;

getStaffSearchSortingFieldsGET

TODO: Add a method description

function getStaffSearchSortingFieldsGET(callback)

Example Usage

    controller.getStaffSearchSortingFieldsGET(function(error, response, context) {

    
    });

getStaffSearchFieldsGET

TODO: Add a method description

function getStaffSearchFieldsGET(callback)

Example Usage

    controller.getStaffSearchFieldsGET(function(error, response, context) {

    
    });

getDomainOptionsGET

TODO: Add a method description

function getDomainOptionsGET(callback)

Example Usage

    controller.getDomainOptionsGET(function(error, response, context) {

    
    });

getAllStaffIdsGET

TODO: Add a method description

function getAllStaffIdsGET(callback)

Example Usage

    controller.getAllStaffIdsGET(function(error, response, context) {

    
    });

getCheckingUrlIdByUrlIdGET

TODO: Add a method description

function getCheckingUrlIdByUrlIdGET(urlId, callback)

Parameters

Example Usage

    var urlId = 'urlId';

    controller.getCheckingUrlIdByUrlIdGET(urlId, function(error, response, context) {

    
    });

getDoesHaveCVByStaffIdGET

TODO: Add a method description

function getDoesHaveCVByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getDoesHaveCVByStaffIdGET(staffId, function(error, response, context) {

    
    });

getDoesHavePhotoByStaffIdGET

TODO: Add a method description

function getDoesHavePhotoByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getDoesHavePhotoByStaffIdGET(staffId, function(error, response, context) {

    
    });

getApproachOptionsByDomainIdGET

TODO: Add a method description

function getApproachOptionsByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getApproachOptionsByDomainIdGET(domainId, function(error, response, context) {

    
    });

getAuthorDetailsByStaffIdGET

TODO: Add a method description

function getAuthorDetailsByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getAuthorDetailsByStaffIdGET(staffId, function(error, response, context) {

    
    });

getAuthorsNewKeywordsByStaffIdGET

TODO: Add a method description

function getAuthorsNewKeywordsByStaffIdGET(newKeywordGroupId, staffId, callback)

Parameters

Example Usage

    var newKeywordGroupId = 158;
    var staffId = 'staffId';

    controller.getAuthorsNewKeywordsByStaffIdGET(newKeywordGroupId, staffId, function(error, response, context) {

    
    });

getBookSellingLinksByStaffIdGET

TODO: Add a method description

function getBookSellingLinksByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getBookSellingLinksByStaffIdGET(staffId, function(error, response, context) {

    
    });

getBuildingByDomainIdModeByStaffIdGET

TODO: Add a method description

function getBuildingByDomainIdModeByStaffIdGET(staffId, domainId, mode, callback)

Parameters

Example Usage

    var staffId = 'staffId';
    var domainId = 158;
    var mode = 'mode';

    controller.getBuildingByDomainIdModeByStaffIdGET(staffId, domainId, mode, function(error, response, context) {

    
    });

getBuildingByOrgUnitCodeModeByStaffIdGET

TODO: Add a method description

function getBuildingByOrgUnitCodeModeByStaffIdGET(staffId, orgUnitCode, mode, callback)

Parameters

Example Usage

    var staffId = 'staffId';
    var orgUnitCode = 'orgUnitCode';
    var mode = 'mode';

    controller.getBuildingByOrgUnitCodeModeByStaffIdGET(staffId, orgUnitCode, mode, function(error, response, context) {

    
    });

getCentreListForStaffByStaffIdGET

TODO: Add a method description

function getCentreListForStaffByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getCentreListForStaffByStaffIdGET(staffId, function(error, response, context) {

    
    });

getCollaboratorByStaffIdGET

TODO: Add a method description

function getCollaboratorByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getCollaboratorByStaffIdGET(staffId, function(error, response, context) {

    
    });

getCountryOptionsByDomainIdGET

TODO: Add a method description

function getCountryOptionsByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getCountryOptionsByDomainIdGET(domainId, function(error, response, context) {

    
    });

getCurrentGrantSizeByStaffIdGET

TODO: Add a method description

function getCurrentGrantSizeByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getCurrentGrantSizeByStaffIdGET(staffId, function(error, response, context) {

    
    });

getDepartmentMembersByCodeGET

TODO: Add a method description

function getDepartmentMembersByCodeGET(code, callback)

Parameters

Example Usage

    var code = 'code';

    controller.getDepartmentMembersByCodeGET(code, function(error, response, context) {

    
    });

createGetDesciplineOptionsPOST

TODO: Add a method description

function createGetDesciplineOptionsPOST(body, callback)

Parameters

Example Usage

    var body = new GetDesciplineOptionsPOSTRequest({"key":"value"});

    controller.createGetDesciplineOptionsPOST(body, function(error, response, context) {

    
    });

getDomainMembersByDomainIdGET

TODO: Add a method description

function getDomainMembersByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getDomainMembersByDomainIdGET(domainId, function(error, response, context) {

    
    });

getDomainMembersWithExpertiseInfoGET

TODO: Add a method description

function getDomainMembersWithExpertiseInfoGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getDomainMembersWithExpertiseInfoGET(domainId, function(error, response, context) {

    
    });

getExpertiseDetailsByStaffIdGET

TODO: Add a method description

function getExpertiseDetailsByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getExpertiseDetailsByStaffIdGET(staffId, function(error, response, context) {

    
    });

getGrantDetailsByStaffIdGET

TODO: Add a method description

function getGrantDetailsByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getGrantDetailsByStaffIdGET(staffId, function(error, response, context) {

    
    });

getGrantSizeByStaffIdGET

TODO: Add a method description

function getGrantSizeByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getGrantSizeByStaffIdGET(staffId, function(error, response, context) {

    
    });

getGrantsForCentreByCentreIdGET

TODO: Add a method description

function getGrantsForCentreByCentreIdGET(centreId, callback)

Parameters

Example Usage

    var centreId = 'centreId';

    controller.getGrantsForCentreByCentreIdGET(centreId, function(error, response, context) {

    
    });

getHonoursProjectByProjIdGET

TODO: Add a method description

function getHonoursProjectByProjIdGET(projId, callback)

Parameters

Example Usage

    var projId = 'projId';

    controller.getHonoursProjectByProjIdGET(projId, function(error, response, context) {

    
    });

getHonoursSupervisorByStaffIdGET

TODO: Add a method description

function getHonoursSupervisorByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getHonoursSupervisorByStaffIdGET(staffId, function(error, response, context) {

    
    });

getHrPersonByStaffIdGET

TODO: Add a method description

function getHrPersonByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getHrPersonByStaffIdGET(staffId, function(error, response, context) {

    
    });

getKeywordOptionsByDomainIdGET

TODO: Add a method description

function getKeywordOptionsByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getKeywordOptionsByDomainIdGET(domainId, function(error, response, context) {

    
    });

getMediaKeywordsByStaffIdGET

TODO: Add a method description

function getMediaKeywordsByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getMediaKeywordsByStaffIdGET(staffId, function(error, response, context) {

    
    });

getMembersByCodeAndJobTypeByCodeGET

TODO: Add a method description

function getMembersByCodeAndJobTypeByCodeGET(code, jobType, callback)

Parameters

Example Usage

    var code = 'code';
    var jobType = 158;

    controller.getMembersByCodeAndJobTypeByCodeGET(code, jobType, function(error, response, context) {

    
    });

createGetMembersByCodeListAndJobTypePOST

TODO: Add a method description

function createGetMembersByCodeListAndJobTypePOST(body, jobType, callback)

Parameters

Example Usage

    var body = new GetMembersByCodeListAndJobTypePOSTRequest({"key":"value"});
    var jobType = 158;

    controller.createGetMembersByCodeListAndJobTypePOST(body, jobType, function(error, response, context) {

    
    });

getMembersByDomainAndJobTypeByDomainIdGET

TODO: Add a method description

function getMembersByDomainAndJobTypeByDomainIdGET(domainId, jobType, callback)

Parameters

Example Usage

    var domainId = 'domainId';
    var jobType = 158;

    controller.getMembersByDomainAndJobTypeByDomainIdGET(domainId, jobType, function(error, response, context) {

    
    });

createGetMembersByDomainListAndJobTypePOST

TODO: Add a method description

function createGetMembersByDomainListAndJobTypePOST(body, jobType, callback)

Parameters

Example Usage

    var body = new GetMembersByDomainListAndJobTypePOSTRequest({"key":"value"});
    var jobType = 249;

    controller.createGetMembersByDomainListAndJobTypePOST(body, jobType, function(error, response, context) {

    
    });

getNewKeywordsByGroupByNewKeywordGroupIdGET

TODO: Add a method description

function getNewKeywordsByGroupByNewKeywordGroupIdGET(newKeywordGroupId, callback)

Parameters

Example Usage

    var newKeywordGroupId = 249;

    controller.getNewKeywordsByGroupByNewKeywordGroupIdGET(newKeywordGroupId, function(error, response, context) {

    
    });

getOrgUnitsByTypeByTypeGET

TODO: Add a method description

function getOrgUnitsByTypeByTypeGET(type, callback)

Parameters

Example Usage

    var type = 249;

    controller.getOrgUnitsByTypeByTypeGET(type, function(error, response, context) {

    
    });

getProfileUrlByDomainIdByDomainIdGET

TODO: Add a method description

function getProfileUrlByDomainIdByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 249;

    controller.getProfileUrlByDomainIdByDomainIdGET(domainId, function(error, response, context) {

    
    });

getProfileUrlByOrgUnitCodeByOrgUnitCodeGET

TODO: Add a method description

function getProfileUrlByOrgUnitCodeByOrgUnitCodeGET(orgUnitCode, callback)

Parameters

Example Usage

    var orgUnitCode = 'orgUnitCode';

    controller.getProfileUrlByOrgUnitCodeByOrgUnitCodeGET(orgUnitCode, function(error, response, context) {

    
    });

getProjectSearchResultSizeByQueryStringGET

TODO: Add a method description

function getProjectSearchResultSizeByQueryStringGET(queryString, callback)

Parameters

Example Usage

    var queryString = 'queryString';

    controller.getProjectSearchResultSizeByQueryStringGET(queryString, function(error, response, context) {

    
    });

getPublicationAuthorByYearYEndByStaffIdGET

TODO: Add a method description

function getPublicationAuthorByYearYEndByStaffIdGET(staffId, yStart, yEnd, callback)

Parameters

Example Usage

    var staffId = 'staffId';
    var yStart = 'yStart';
    var yEnd = 'yEnd';

    controller.getPublicationAuthorByYearYEndByStaffIdGET(staffId, yStart, yEnd, function(error, response, context) {

    
    });

createGetPublicationsPOST

TODO: Add a method description

function createGetPublicationsPOST(body, callback)

Parameters

Example Usage

    var body = new GetPublicationsPOSTRequest({"key":"value"});

    controller.createGetPublicationsPOST(body, function(error, response, context) {

    
    });

getPublicationsForCentreByCentreIdGET

TODO: Add a method description

function getPublicationsForCentreByCentreIdGET(centreId, callback)

Parameters

Example Usage

    var centreId = 'centreId';

    controller.getPublicationsForCentreByCentreIdGET(centreId, function(error, response, context) {

    
    });

createGetPublicationsForGroupPOST

TODO: Add a method description

function createGetPublicationsForGroupPOST(body, callback)

Parameters

Example Usage

    var body = new GetPublicationsForGroupPOSTRequest({"key":"value"});

    controller.createGetPublicationsForGroupPOST(body, function(error, response, context) {

    
    });

getPublishingActiveAuthorByStaffIdGET

TODO: Add a method description

function getPublishingActiveAuthorByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getPublishingActiveAuthorByStaffIdGET(staffId, function(error, response, context) {

    
    });

getResearchSupervisorByStaffIdGET

TODO: Add a method description

function getResearchSupervisorByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getResearchSupervisorByStaffIdGET(staffId, function(error, response, context) {

    
    });

getSearchResultSizeByQueryStringGET

TODO: Add a method description

function getSearchResultSizeByQueryStringGET(queryString, callback)

Parameters

Example Usage

    var queryString = 'queryString';

    controller.getSearchResultSizeByQueryStringGET(queryString, function(error, response, context) {

    
    });

getSelectOptionsByCategoryAndDomainIdGET

TODO: Add a method description

function getSelectOptionsByCategoryAndDomainIdGET(category, domainId, callback)

Parameters

Example Usage

    var category = 'category';
    var domainId = 'domainId';

    controller.getSelectOptionsByCategoryAndDomainIdGET(category, domainId, function(error, response, context) {

    
    });

getStaffIdByUrlIdGET

TODO: Add a method description

function getStaffIdByUrlIdGET(urlId, callback)

Parameters

Example Usage

    var urlId = 'urlId';

    controller.getStaffIdByUrlIdGET(urlId, function(error, response, context) {

    
    });

getStaffListByCentreIdByCentreIdGET

TODO: Add a method description

function getStaffListByCentreIdByCentreIdGET(centreId, callback)

Parameters

Example Usage

    var centreId = 'centreId';

    controller.getStaffListByCentreIdByCentreIdGET(centreId, function(error, response, context) {

    
    });

getStaffListByIRMACenterIdByCenterIdGET

TODO: Add a method description

function getStaffListByIRMACenterIdByCenterIdGET(centerId, callback)

Parameters

Example Usage

    var centerId = 'centerId';

    controller.getStaffListByIRMACenterIdByCenterIdGET(centerId, function(error, response, context) {

    
    });

getStaffProfileUrlByStaffIdGET

TODO: Add a method description

function getStaffProfileUrlByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getStaffProfileUrlByStaffIdGET(staffId, function(error, response, context) {

    
    });

getStaffProfileUrlForReportingByStaffIdGET

TODO: Add a method description

function getStaffProfileUrlForReportingByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getStaffProfileUrlForReportingByStaffIdGET(staffId, function(error, response, context) {

    
    });

getSupervisedStudentsByStaffIdGET

TODO: Add a method description

function getSupervisedStudentsByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getSupervisedStudentsByStaffIdGET(staffId, function(error, response, context) {

    
    });

getThemeOptionsByDomainIdGET

TODO: Add a method description

function getThemeOptionsByDomainIdGET(domainId, callback)

Parameters

Example Usage

    var domainId = 'domainId';

    controller.getThemeOptionsByDomainIdGET(domainId, function(error, response, context) {

    
    });

getThemeOptionsByOrgUnitCodeGET

TODO: Add a method description

function getThemeOptionsByOrgUnitCodeGET(orgUnitCode, callback)

Parameters

Example Usage

    var orgUnitCode = 'orgUnitCode';

    controller.getThemeOptionsByOrgUnitCodeGET(orgUnitCode, function(error, response, context) {

    
    });

getThemesByStaffIdGET

TODO: Add a method description

function getThemesByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getThemesByStaffIdGET(staffId, function(error, response, context) {

    
    });

getThesisListByStaffIdGET

TODO: Add a method description

function getThesisListByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getThesisListByStaffIdGET(staffId, function(error, response, context) {

    
    });

getIsBlacklistedByStaffIdGET

TODO: Add a method description

function getIsBlacklistedByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getIsBlacklistedByStaffIdGET(staffId, function(error, response, context) {

    
    });

getIsCurrentByStaffIdGET

TODO: Add a method description

function getIsCurrentByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getIsCurrentByStaffIdGET(staffId, function(error, response, context) {

    
    });

getIsCurrentInDomainByStaffIdAndDomainIdGET

TODO: Add a method description

function getIsCurrentInDomainByStaffIdAndDomainIdGET(staffId, domainId, callback)

Parameters

Example Usage

    var staffId = 'staffId';
    var domainId = 'domainId';

    controller.getIsCurrentInDomainByStaffIdAndDomainIdGET(staffId, domainId, function(error, response, context) {

    
    });

getIsCurrentInOrgUnitCodeByStaffIdGET

TODO: Add a method description

function getIsCurrentInOrgUnitCodeByStaffIdGET(staffId, orgUnitCode, callback)

Parameters

Example Usage

    var staffId = 'staffId';
    var orgUnitCode = 'orgUnitCode';

    controller.getIsCurrentInOrgUnitCodeByStaffIdGET(staffId, orgUnitCode, function(error, response, context) {

    
    });

getPerformProjectSearchRangeSortIsReverseGET

TODO: Add a method description

function getPerformProjectSearchRangeSortIsReverseGET(queryString, startIndex, range, sort, isReverse, callback)

Parameters

Example Usage

    var queryString = 'queryString';
    var startIndex = 249;
    var range = 249;
    var sort = 'sort';
    var isReverse = true;

    controller.getPerformProjectSearchRangeSortIsReverseGET(queryString, startIndex, range, sort, isReverse, function(error, response, context) {

    
    });

getPerformSimpleAttributeSearchRangeSortIsReverseGET

TODO: Add a method description

function getPerformSimpleAttributeSearchRangeSortIsReverseGET(queryString, startIndex, range, sort, isReverse, callback)

Parameters

Example Usage

    var queryString = 'queryString';
    var startIndex = 249;
    var range = 249;
    var sort = 'sort';
    var isReverse = true;

    controller.getPerformSimpleAttributeSearchRangeSortIsReverseGET(queryString, startIndex, range, sort, isReverse, function(error, response, context) {

    
    });

getUpdateCacheByStaffIdGET

TODO: Add a method description

function getUpdateCacheByStaffIdGET(staffId, callback)

Parameters

Example Usage

    var staffId = 'staffId';

    controller.getUpdateCacheByStaffIdGET(staffId, function(error, response, context) {

    
    });

Back to List of Controllers