Menu
MAGIQ Platform Integration

API for MAGIQ Documents

MAGIQ Documents provides a comprehensive Web Services API which allows organisations to develop custom integration solutions. Using the Web Services API, you will be able to retrieve documents, search for documents, upload new documents from your in-house applications.

 

Some of the supported operations include:

  • User Authentication
  • Document functions (e.g. create, check out, checkin, etc.)
  • Folder functions
  • Document and Folder common functions
  • Applying and Retrieving Meta to the Objects
  • Searching Documents and Folders
  • Domains (Workareas, Root Level Folders)
  • Domain Memberships, Local Users, Local Groups and Domain Managers
  • User Management
  • User Group Management
  • Archiving

 

Examples of Commonly Used API Functions

Search for Documents and Folders

AuthenticateUser
Authenticates the specified user against infoXpert

isValidTicket
Determines whether the given ticket is still valid or not

Search
Prepares a search results using given criteria in xml format

GetNextSearchPage
Returns search results with xx records retreived per page (based on system parameters)

GetPreviousSearchPage
Returns search results from previous results page (if applicable)

DownloadDocument
Downloads a document in byte array format

 

Create Folders

AuthenticateUser
Authenticates the specified user against infoXpert

isValidTicket
Determines whether the given ticket is still valid or not

GetDomains
Returns a list of infoxpert domains/libraries

CreateFolder
Creates the specified path. Multiple sub-folders can be created. The caller must have at least “Add” permissions on the parent folder

AddPropertySetRow
Adds a property set row to a folder in the specified path. For example Property ID for integration. Use UpdatePropertySetRow if updating an existing property set row (unless there are multiples).

 

Upload (Create) Documents

AuthenticateUser
Authenticates the specified user against infoXpert

isValidTicket
Determines whether the given ticket is still valid or not

UploadDocument
Uploads a new document or creates a new version of an existing document in byte array format to the specified path (or can use UploadDocument1, UploadDocument2 or UploadDocument3 if additional version information to be supplied)

UpdateDocumentProperties
Sets the Name and Description of the document.

UpdateDocumentType
Updates the type of the document.

Use GetDocumentTypes to return available document types

AddPropertySetRow
Adds a property set row to a document or a folder in the specified path. For example Correspondent Name and Address.
Use UpdatePropertySetRow if updating an existing property set row (unless there are multiples)
Note: use GetDocumentTypes to identify manadtory property set for selected document type

AddDocumentComment
Adds an optional comment to the specified document

SetDocumentCompletionStatus
Sets the optional completion status of the specified document

For uploading emails you should use the RegisterEmail API function.

 

Documentation: Complete List of API Functions

For a complete list of API functions and documentation login to the MAGIQ Software Online Service Desk and follow this link:

https://support.magiqsoftware.com/hc/en-nz/sections/360012170073-Integration-Framework-Documentation