iApply JSON API
Provides a JSON Application Programming Interface (API) into the iApply system.
The following operations are supported. For a formal definition, please review the Service Description.
-
AssignApplication
Assigns application to the users defined in assignees list or clear assignee of the application if assignees list is empty. -
CreateApplication
Creates a new application in form with ID formId and updates that application's data to the contents of applicationData. -
Export
Exports data containing specified forms / users, as well as related data such as roles, workflow configurations etc. -
FindApplicationsByOrganisation
Retrieves application data from the iApply system that matches supplied data for the given organisation ids. -
GetApplication
Retrieves an application with the supplied application ID. -
GetApplicationByDisplayId
Retrieves application data from the iApply system that matches supplied data for the given application display ID. -
GetApplicationPdf
Retrieves a system generated PDF for application with specified ID, as base64 data. -
GetDocGenFile
Retrieves a document generated file from the application with a specified control name, as base64 data. -
GetUploadedFile
Retrieves a user-uploaded file for application with specified ID, as base64 data. -
Import
Imports data into the data store, including users, roles, forms etc. -
ListApplicationAttachments
Retrieves a user-uploaded file for application with specified ID, as base64 data. -
UpdateApplication
Updates an application with supplied application data. -
UpdateUsers
Updates the details of one or more users. -
WhoAmI
Get the raw JSON details of the currently logged in user. -
WhoAmIStr
Get the details of the currently logged in user.