api

Api - JavaScript client for api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/api then install it via:

    npm install YOUR_USERNAME/api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Api = require('api');

var api = new Api.DefaultApi()

var urlId = "urlId_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkingUrlIdByUrlIdGet(urlId, callback);

Documentation for API Endpoints

All URIs are relative to http://api.profiles.sydney.edu.au/AcademicProfiles/interfaces/rest

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Api.DefaultApi | checkingUrlIdByUrlIdGet | GET /checkingUrlId/{urlId} | CheckingUrlIdByUrlId_GET Api.DefaultApi | doesHaveCVByStaffIdGet | GET /doesHaveCV/{staffId} | DoesHaveCVByStaffId_GET Api.DefaultApi | doesHavePhotoByStaffIdGet | GET /doesHavePhoto/{staffId} | DoesHavePhotoByStaffId_GET Api.DefaultApi | getAllStaffIdsGet | GET /getAllStaffIds | GetAllStaffIds_GET Api.DefaultApi | getApproachOptionsByDomainIdGet | GET /getApproachOptions/{domainId} | GetApproachOptionsByDomainId_GET Api.DefaultApi | getAuthorDetailsByStaffIdGet | GET /getAuthorDetails/{staffId} | GetAuthorDetailsByStaffId_GET Api.DefaultApi | getAuthorsNewKeywordsByStaffIdAndNewKeywordGroupIdGet | GET /getAuthorsNewKeywords/{staffId}/{newKeywordGroupId} | GetAuthorsNewKeywordsByStaffId_GET Api.DefaultApi | getBookSellingLinksByStaffIdGet | GET /getBookSellingLinks/{staffId} | GetBookSellingLinksByStaffId_GET Api.DefaultApi | getBuildingByDomainIdModeByStaffIdAndDomainIdGet | GET /getBuildingByDomainId/{staffId}/{domainId}/{mode} | GetBuildingByDomainIdModeByStaffId_GET Api.DefaultApi | getBuildingByOrgUnitCodeModeByStaffIdAndOrgUnitCodeGet | GET /getBuildingByOrgUnitCode/{staffId}/{orgUnitCode}/{mode} | GetBuildingByOrgUnitCodeModeByStaffId_GET Api.DefaultApi | getCentreListForStaffByStaffIdGet | GET /getCentreListForStaff/{staffId} | GetCentreListForStaffByStaffId_GET Api.DefaultApi | getCollaboratorByStaffIdGet | GET /getCollaborator/{staffId} | GetCollaboratorByStaffId_GET Api.DefaultApi | getCountryOptionsByDomainIdGet | GET /getCountryOptions/{domainId} | GetCountryOptionsByDomainId_GET Api.DefaultApi | getCurrentGrantSizeByStaffIdGet | GET /getCurrentGrantSize/{staffId} | GetCurrentGrantSizeByStaffId_GET Api.DefaultApi | getDepartmentMembersByCodeGet | GET /getDepartmentMembers/{code} | GetDepartmentMembersByCode_GET Api.DefaultApi | getDesciplineOptionsPost | POST /getDesciplineOptions | GetDesciplineOptions_POST Api.DefaultApi | getDomainMembersByDomainIdGet | GET /getDomainMembers/{domainId} | GetDomainMembersByDomainId_GET Api.DefaultApi | getDomainMembersWithExpertiseInfoByDomainIdGet | GET /getDomainMembersWithExpertiseInfo/{domainId} | GetDomainMembersWithExpertiseInfo_GET Api.DefaultApi | getDomainOptionsGet | GET /getDomainOptions | GetDomainOptions_GET Api.DefaultApi | getExpertiseDetailsByStaffIdGet | GET /getExpertiseDetails/{staffId} | GetExpertiseDetailsByStaffId_GET Api.DefaultApi | getGrantDetailsByStaffIdGet | GET /getGrantDetails/{staffId} | GetGrantDetailsByStaffId_GET Api.DefaultApi | getGrantSizeByStaffIdGet | GET /getGrantSize/{staffId} | GetGrantSizeByStaffId_GET Api.DefaultApi | getGrantsForCentreByCentreIdGet | GET /getGrantsForCentre/{centreId} | GetGrantsForCentreByCentreId_GET Api.DefaultApi | getHonoursProjectByProjIdGet | GET /getHonoursProject/{projId} | GetHonoursProjectByProjId_GET Api.DefaultApi | getHonoursSupervisorByStaffIdGet | GET /getHonoursSupervisor/{staffId} | GetHonoursSupervisorByStaffId_GET Api.DefaultApi | getHrPersonByStaffIdGet | GET /getHrPerson/{staffId} | GetHrPersonByStaffId_GET Api.DefaultApi | getKeywordOptionsByDomainIdGet | GET /getKeywordOptions/{domainId} | GetKeywordOptionsByDomainId_GET Api.DefaultApi | getMediaKeywordsByStaffIdGet | GET /getMediaKeywords/{staffId} | GetMediaKeywordsByStaffId_GET Api.DefaultApi | getMembersByCodeAndJobTypeByCodeAndJobTypeGet | GET /getMembersByCodeAndJobType/{code}/{jobType} | GetMembersByCodeAndJobTypeByCode_GET Api.DefaultApi | getMembersByCodeListAndJobTypePost | POST /getMembersByCodeListAndJobType | GetMembersByCodeListAndJobType_POST Api.DefaultApi | getMembersByDomainAndJobTypeByDomainIdAndJobTypeGet | GET /getMembersByDomainAndJobType/{domainId}/{jobType} | GetMembersByDomainAndJobTypeByDomainId_GET Api.DefaultApi | getMembersByDomainListAndJobTypePost | POST /getMembersByDomainListAndJobType | GetMembersByDomainListAndJobType_POST Api.DefaultApi | getNewKeywordsByGroupByNewKeywordGroupIdGet | GET /getNewKeywordsByGroup/{newKeywordGroupId} | GetNewKeywordsByGroupByNewKeywordGroupId_GET Api.DefaultApi | getOrgUnitsByTypeByTypeGet | GET /getOrgUnitsByType/{type} | GetOrgUnitsByTypeByType_GET Api.DefaultApi | getProfileUrlByDomainIdByDomainIdGet | GET /getProfileUrlByDomainId/{domainId} | GetProfileUrlByDomainIdByDomainId_GET Api.DefaultApi | getProfileUrlByOrgUnitCodeByOrgUnitCodeGet | GET /getProfileUrlByOrgUnitCode/{orgUnitCode} | GetProfileUrlByOrgUnitCodeByOrgUnitCode_GET Api.DefaultApi | getProjectSearchResultSizeByQueryStringGet | GET /getProjectSearchResultSize/{queryString} | GetProjectSearchResultSizeByQueryString_GET Api.DefaultApi | getPublicationAuthorByYearYEndByStaffIdAndYStartGet | GET /getPublicationAuthorByYear/{staffId}/{yStart}/{yEnd} | GetPublicationAuthorByYearYEndByStaffId_GET Api.DefaultApi | getPublicationsForCentreByCentreIdGet | GET /getPublicationsForCentre/{centreId} | GetPublicationsForCentreByCentreId_GET Api.DefaultApi | getPublicationsForGroupPost | POST /getPublicationsForGroup | GetPublicationsForGroup_POST Api.DefaultApi | getPublicationsPost | POST /getPublications | GetPublications_POST Api.DefaultApi | getPublishingActiveAuthorByStaffIdGet | GET /getPublishingActiveAuthor/{staffId} | GetPublishingActiveAuthorByStaffId_GET Api.DefaultApi | getResearchSupervisorByStaffIdGet | GET /getResearchSupervisor/{staffId} | GetResearchSupervisorByStaffId_GET Api.DefaultApi | getSearchResultSizeByQueryStringGet | GET /getSearchResultSize/{queryString} | GetSearchResultSizeByQueryString_GET Api.DefaultApi | getSelectOptionsByCategoryAndDomainIdGet | GET /getSelectOptions/{category}/{domainId} | GetSelectOptionsByCategoryAndDomainId_GET Api.DefaultApi | getStaffIdByUrlIdGet | GET /getStaffId/{urlId} | GetStaffIdByUrlId_GET Api.DefaultApi | getStaffListByCentreIdByCentreIdGet | GET /getStaffListByCentreId/{centreId} | GetStaffListByCentreIdByCentreId_GET Api.DefaultApi | getStaffListByIRMACenterIdByCenterIdGet | GET /getStaffListByIRMACenterId/{centerId} | GetStaffListByIRMACenterIdByCenterId_GET Api.DefaultApi | getStaffProfileUrlByStaffIdGet | GET /getStaffProfileUrl/{staffId} | GetStaffProfileUrlByStaffId_GET Api.DefaultApi | getStaffProfileUrlForReportingByStaffIdGet | GET /getStaffProfileUrlForReporting/{staffId} | GetStaffProfileUrlForReportingByStaffId_GET Api.DefaultApi | getStaffSearchFieldsGet | GET /getStaffSearchFields | GetStaffSearchFields_GET Api.DefaultApi | getStaffSearchSortingFieldsGet | GET /getStaffSearchSortingFields | GetStaffSearchSortingFields_GET Api.DefaultApi | getSupervisedStudentsByStaffIdGet | GET /getSupervisedStudents/{staffId} | GetSupervisedStudentsByStaffId_GET Api.DefaultApi | getThemeOptionsByDomainIdGet | GET /getThemeOptions/{domainId} | GetThemeOptionsByDomainId_GET Api.DefaultApi | getThemeOptionsByOrgUnitCodeByOrgUnitCodeGet | GET /getThemeOptionsByOrgUnitCode/{orgUnitCode} | GetThemeOptionsByOrgUnitCode_GET Api.DefaultApi | getThemesByStaffIdGet | GET /getThemes/{staffId} | GetThemesByStaffId_GET Api.DefaultApi | getThesisListByStaffIdGet | GET /getThesisList/{staffId} | GetThesisListByStaffId_GET Api.DefaultApi | isBlacklistedByStaffIdGet | GET /isBlacklisted/{staffId} | IsBlacklistedByStaffId_GET Api.DefaultApi | isCurrentByStaffIdGet | GET /isCurrent/{staffId} | IsCurrentByStaffId_GET Api.DefaultApi | isCurrentInDomainByStaffIdAndDomainIdGet | GET /isCurrentInDomain/{staffId}/{domainId} | IsCurrentInDomainByStaffIdAndDomainId_GET Api.DefaultApi | isCurrentInOrgUnitCodeByStaffIdAndOrgUnitCodeGet | GET /isCurrentInOrgUnitCode/{staffId}/{orgUnitCode} | IsCurrentInOrgUnitCodeByStaffId_GET Api.DefaultApi | performProjectSearchRangeSortIsReverseByQueryStringAndStartIndexGet | GET /performProjectSearch/{queryString}/{startIndex}/{range}/{sort}/{isReverse} | PerformProjectSearchRangeSortIsReverse_GET Api.DefaultApi | performSimpleAttributeSearchRangeSortIsReverseByQueryStringAndStartIndexGet | GET /performSimpleAttributeSearch/{queryString}/{startIndex}/{range}/{sort}/{isReverse} | PerformSimpleAttributeSearchRangeSortIsReverse_GET Api.DefaultApi | updateCacheByStaffIdGet | GET /updateCache/{staffId} | UpdateCacheByStaffId_GET

Documentation for Models

• Api.DoesHaveCVByStaffIdGETResponse
• Api.DoesHavePhotoByStaffIdGETResponse
• Api.GetBuildingByDomainIdModeByStaffIdGETResponse
• Api.GetBuildingByOrgUnitCodeModeByStaffIdGETResponse
• Api.GetCurrentGrantSizeByStaffIdGETResponse
• Api.GetDesciplineOptionsPOSTRequest
• Api.GetGrantSizeByStaffIdGETResponse
• Api.GetMembersByCodeListAndJobTypePOSTRequest
• Api.GetMembersByDomainListAndJobTypePOSTRequest
• Api.GetProfileUrlByDomainIdByDomainIdGETResponse
• Api.GetProfileUrlByOrgUnitCodeByOrgUnitCodeGETResponse
• Api.GetProjectSearchResultSizeByQueryStringGETResponse
• Api.GetPublicationsForGroupPOSTRequest
• Api.GetPublicationsPOSTRequest
• Api.GetSearchResultSizeByQueryStringGETResponse
• Api.GetStaffIdByUrlIdGETResponse
• Api.GetStaffProfileUrlByStaffIdGETResponse
• Api.GetStaffProfileUrlForReportingByStaffIdGETResponse
• Api.IsBlacklistedByStaffIdGETResponse
• Api.IsCurrentByStaffIdGETResponse
• Api.IsCurrentInDomainByStaffIdAndDomainIdGETResponse
• Api.IsCurrentInOrgUnitCodeByStaffIdGETResponse
• Api.UpdateCacheByStaffIdGETResponse

Documentation for Authorization

All endpoints do not require authorization.