Skip to content

infoRouter Web API Documentation

Welcome to the comprehensive documentation for the infoRouter Web Services API.

Overview

The infoRouter Web Services API provides programmatic access to infoRouter's document management, workflow, and collaboration features. All APIs are available via SOAP, REST (GET), and REST (POST) protocols.

Getting Started

  1. Authentication: Obtain an authentication ticket using AuthenticateUser
  2. Make API Calls: Use the ticket in subsequent API calls
  3. Handle Responses: All responses are in XML format

API Categories

Authentication

  • AuthenticateUser - Authenticate with user name and password, returns ticket and profile info
  • AuthenticateUser1 - Authenticate with user name, password, and an explicit session language
  • AuthenticateUserViaWindows - Authenticate using the Windows identity (NTLM/Kerberos) from the HTTP request context
  • ChangePasswordUsingSecretText - Complete a password reset using the one-time token emailed by ForgotPassword
  • ChangeUserPassword - Change a user's password (self-service or User Manager)
  • CreateTicketforUser - Create an authentication ticket for any user using the server-side trusted password (server-to-server impersonation)
  • ForgotPassword - Initiate a password reset by sending a one-time token to the user's registered email address
  • ForgotPasswordByUserName - Initiate a password reset by login name (sends token to the user's registered email address)
  • isValidTicket - Check whether an authentication ticket is still valid without supplying credentials or extending the expiration
  • LogOut - Invalidate an authentication ticket and clear the server-side session
  • RenewTicket - Validate credentials and renew an existing ticket or issue a fresh one

Application Settings & Configuration

Server & License Management

  • GetLicenseInfo - Get application license details, user counts, and subscription dates (admin only)
  • GetSystemStatistics - Get system-wide statistics: user counts, document counts, total document size, and checked-out documents (admin only)
  • GetLogs - Get server log entries by type and date (admin only)
  • GetLogStatistics - Get log dates and entry counts by log type, fixed 90-day window (admin only)
  • GetLogStatistics1 - Get log dates and entry counts by log type with a caller-supplied lookback window (admin only)
  • GetMaintenanceJobsStatus - Get status of all system maintenance jobs (admin only)
  • GetWarehouseStatus - Get warehouse storage status, document counts, and disk information (admin only)
  • ServerInfo - Get server version, time, and basic license info (no authentication required)
  • UpdateApplicationLicense - Update the application license file (admin only)

Audit Logs

Folder & Document Listing

Folder Management

  • CreateFolder - Create a folder from a single full path (intermediate folders created automatically)
  • CreateFolder1 - Create a subfolder with optional description using separate parent path and name parameters
  • CreateHtmlDocument - Create a new HTML document in a folder with raw HTML content
  • DeleteFolder - Delete a folder and all its contents
  • FolderExists - Check whether a folder exists at the specified path
  • FolderExists1 - Check whether a named subfolder exists within a specified parent folder
  • GetFolder - Get the full properties of a folder with optional rules, property sets, security, and owner details
  • GetFolderCatalog - Get the catalog information for a folder
  • GetFolderRules - Get the rules and policies configured for a folder
  • GetFolderStatistics - Get statistics for a folder (subfolder count, document count, total size)
  • GetFolders - Get the list of direct subfolders with full property details
  • GetFolders1 - Get the list of direct subfolders in short form (no count limit)
  • GetFolders2 - Get the list of direct subfolders in short form with configured UI display limit
  • GetFoldersByPage - Get a paged list of direct subfolders with optional name filtering
  • GetParentFolderIDs - Get the chain of parent folder IDs from root to the specified folder
  • GetSubFoldersCount - Get the count of direct subfolders in a folder
  • Move - Move a document or folder to a new destination path
  • RemoveFolderCutoffDate - Remove the cutoff date from a folder and optionally its subfolders and documents
  • SetFolderCutoffDate - Set the cutoff date on a folder and optionally its subfolders and documents
  • SetFolderRules - Set the rules and policies for a folder (with optional tree propagation)
  • UpdateFolderProperties - Update a folder's name and description

Document Management

Security & Access Control

  • ApplyInheritedAccessList - Apply the inherited (parent) access list to a document or folder, removing any custom security settings
  • DocumentAccessAllowed - Check whether the calling user is allowed to perform a specific action on a document
  • FolderAccessAllowed - Check whether the calling user is allowed to perform a specific action on a folder
  • GetAccessList - Get the current access list (security permissions) for a document or folder
  • GetAccessListHistory - Get the current and historical access list records for a document or folder
  • GetOwner - Get the owner of a document or folder
  • SetAccessList - Set the access list (security permissions) for a document or folder
  • SetOwner - Set the owner of a document or folder

Domain/Library Management

Workflow Management

  • ActivateFlowDef - Activate a workflow definition
  • AddWorkflowAttachment - Attach a document to an active workflow task
  • AddFlowStepDef - Add a new step to an inactive workflow definition (step number auto-assigned)
  • AddFlowStepDef1 - Add a new step to an inactive workflow definition with an optional on-start folder move
  • AddFlowTaskDef - Add a task definition to a step of an inactive workflow definition
  • ChangeTaskDueDate - Change the due date and allowed start time span of an active workflow task
  • CompleteTask - Mark a workflow task as completed and trigger automatic workflow advancement
  • CreateFlowDef - Create a new workflow definition (minimal variant: name, domain, active folder)
  • CreateFlowDef1 - Create a new workflow definition with an on-end destination folder
  • CreateFlowDef2 - Create a new workflow definition with an on-end folder and a supervisor
  • CreateFlowDef3 - Create a new workflow definition with all options (on-end folder, supervisor, event URL, hidden flag)
  • CreateRelatedTask - Create a related ad-hoc task linked to an existing workflow task
  • CreateTask - Create a standalone ad-hoc workflow task and assign it to a document
  • DeactivateFlowDef - Set a workflow definition back to inactive state so its steps and tasks can be modified
  • DeleteFlowStepDef - Delete a step from a workflow definition
  • DeleteTask - Delete an active workflow task and all its attachments by task ID
  • GetDocumentTasks - Return all workflow tasks for a document with optional filtering by completion status, sorted by due date
  • GetDocumentWorkflow - Return the details of a specific running workflow instance on a document
  • GetDocumentWorkflows - Return all workflow instances (current and historical) for a document with optional filtering
  • GetDueTaskDocuments - Return documents that have active (due) workflow tasks assigned to the authenticated user, sorted by due date
  • GetFlowDef - Return the complete definition of a workflow including all step and task definitions
  • GetFolderFlows - Return workflow definitions active on a folder, optionally including inherited flows from parent folders
  • GetTask - Return the full details of a single workflow task including status, assignee, dates, requirements, and attachments
  • GetUserTaskRedirectionTo - Return the task redirection configured for a user (the user their tasks are being forwarded to)
  • GetUserTaskRedirectionsFrom - Return the list of users who are redirecting their tasks to a specified user
  • ReassignTask - Reassign an active workflow task to a different user with a new due date and instructions
  • RemoveCurrentWorkflow - Permanently remove a running workflow from a document (hard delete, no notifications; blocked if any tasks are already completed)
  • RemoveWorkflowAttachment - Remove a previously attached document from an active workflow task
  • RemoveUserTaskRedirection - Remove the task redirection configured for a user so incoming tasks are no longer forwarded
  • RerouteUserTaskRedirection - Change the target user of an existing task redirection while keeping the original date window
  • SetTaskApprovalStatus - Set the approval decision (Approve/Reject/clear) on a workflow task with an Approval requirement
  • SetTaskComment - Set or clear the user comment on an active workflow task
  • SetTaskPriority - Set the priority level of a workflow task (NoPriority/Low/Normal/High/Urgent)
  • SetUserTaskRedirection - Set or replace a task redirection for a user so incoming tasks are forwarded during a date window
  • StopCurrentWorkflow - Gracefully stop a running workflow with notifications to task assignees, submitter, and supervisors
  • SubmitDocumentToFlow - Submit a document to an active workflow definition using the workflow's default task assignees
  • SubmitDocumentToFlow1 - Submit a document to a workflow with custom user/group assignees for the first step
  • TestTaskCompletion - Dry-run check of whether a workflow task can be completed (validates all requirements without completing)
  • UpdateTaskFinishDate - Retroactively update the finish date of a completed workflow task
  • UpdateTaskStatus - Update the status, finish date, and comment of a workflow task in a single call
  • UpdateWorkflowDefinition - Update the properties of an existing workflow definition (name, folder, supervisor, active status, visibility)
  • UpdateWorkflowStepDef - Update the name and on-start folder move of an existing workflow step definition
  • UpdateRunningWorkflowTaskDef - Update a task definition on a currently executing (running) workflow step
  • UpdateWorkflowTaskDef - Update an existing task definition within a workflow step (name, deadline, assignees, permissions, requirements)
  • DeleteFlowTaskDef - Delete a task definition from a workflow step
  • DeleteWorkflow - Permanently delete a workflow definition by ID
  • getTasks - Get a filtered list of workflow tasks with sorting and XML-based search criteria
  • GetTasks1 - Get a paged list of workflow tasks with startingRow and rowCount pagination support
  • GetUsersTaskPerformance - Get user task performance statistics (due and overdue task counts)
  • GetUsersWorkflowRoles - Get workflow roles assigned to a user (supervisor and assignee roles)
  • GetWorkflowDefinitions - Get all workflow definitions in the system with optional active-only filter (admin only)
  • GetWorkflowStatistics - Get workflow performance statistics (pending, completed, overdue counts)

Property Sets

Retention & Disposition

ISO Review

Notifications & Distribution

  • DistributeDocument - Send OnChange distribution notification email to all subscribers of a document
  • SendEmail - Send documents and/or folders to recipients by email as links, ZIP, or individual attachments

User Group Management

  • GetNextSearchPage - Get the next page of a prepared search result set
  • GetPreviousSearchPage - Get the previous page of a prepared search result set
  • DeleteSearchPage - Delete a saved search page definition by ID
  • GetSearchPage - Get the full definition of a single search page including field-visibility configuration
  • GetSearchPages - List all search page definitions visible to the current user
  • SaveSearchPage - Create or update a search page definition
  • Search - Prepare a search result set using XML-based criteria with sorting options

Document Associations

Tags

Subscription Management

Recycle Bin

  • EmptyRecycleBin - Permanently delete all items in the current user's Recycle Bin
  • GetRecycleBinContent - List all documents and folders currently in the current user's Recycle Bin
  • PurgeRecycleBinItem - Permanently delete a single item from the Recycle Bin by handler (admin only)
  • RestoreRecycleBinItem - Restore a single Recycle Bin item to its original or a specified folder location
  • SearchRecycledItems - Search documents and folders across all users' Recycle Bins with optional filters (admin only)

User Management

Miscellaneous

  • GetAddInInfo - Get version and description information for a deployed client Add-in
  • GetAddInPart - Download the installation package (parts.zip) for a deployed client Add-in as a byte array
  • GetLocalizedResources - Get localized display strings for specified infoRouter resource IDs
  • MaintenanceBeat - Obsolete -" formerly triggered server self-maintenance tasks; the implementation is a no-op and returns no response

Common Patterns

Authentication

POST /srv.asmx/AuthenticateUser
Content-Type: application/x-www-form-urlencoded

UID=username&PWD=password

Response: 

<root success="true" ticket="abc123-def456-..." />

Error Handling

All APIs return errors in this format: 

<root success="false" error="[ErrorCode] Error message" />

Response Format

All API responses follow this structure: 

<root success="true|false" error="error message if failed">
  <!-- Response data -->
</root>

API Endpoints

  • SOAP: https://yourserver/srv.asmx
  • REST: https://yourserver/srv.asmx/[MethodName]

Support

For additional information and support: - GitHub: https://github.com/inforouter/webserver - Support Site: https://support.inforouter.com

Version

Compatible with infoRouter 8.7 and later.

Last Updated: 2026