Connectors Reference

GoFileRoom

GoFileRoom is a cloud-based document management and workflow solution. With the GoFileRoom connector, you can perform document, user management, and FirmFlow actions.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

CreateGroup ([Optional]string X-Authorization, [Optional]CreateGroupParameterBody body)

Create Group

SetGroupDocSecurity ([Optional]string X-Authorization, [Optional]SetGroupDocSecurityParameterBody body)

Set Group Document Security

ModifyGroup ([Optional]string X-Authorization, [Optional]ModifyGroupParameterBody body)

Modify Group

GetGroupPermissions ([Optional]string groupName, [Optional]string X-Authorization)

Get Group Permissions

SetGroupPermissions ([Optional]string X-Authorization, [Optional]SetGroupPermissionsParameterBody body)

Set Group Permissions

GetGroupDocumentSecurity (string groupName, string cabinetName, string drawerName, [Optional]string X-Authorization)

Get Group Document Security

GetGroups ([Optional]string X-Authorization)

Get Groups

CreateUsers ([Optional]string userType, [Optional]string X-Authorization, [Optional]CreateUsersParameterBody body)

Create Users

DeleteUser ([Optional]string X-Authorization, [Optional]DeleteUserParameterBody body)

Delete User

SetUserDocSecurity ([Optional]string X-Authorization, [Optional]SetUserDocSecurityParameterBody body)

Set User Document Security

GetUserInfo ([Optional]string X-Authorization, [Optional]GetUserInfoParameterBody body)

Get User Info

GetLicenses ([Optional]string license, [Optional]string X-Authorization)

Get Licenses

ModifyUser ([Optional]string userType, [Optional]string X-Authorization, [Optional]ModifyUserParameterBody body)

Modify User

GetPasswordPolicy ([Optional]string X-Authorization)

Get Password Policy

SetUserPermissions ([Optional]string X-Authorization, [Optional]SetUserPermissionsParameterBody body)

Set User Permissions

GetListOfReports ([Optional]string X-Authorization)

Get List of Reports

GetUploadLocation ([Optional]string X-Authorization)

Get Upload Locations

GetUserDocumentSecurity (string loginId, string cabinetName, string drawerName, [Optional]string X-Authorization)

Get User Document Security

GetUserPermission (string login, [Optional]string X-Authorization)

Get User Permissions

GetUsers ([Optional]string userType, [Optional]string X-Authorization)

Get Users

GetLookupList (string drawerId, [Optional]string X-Authorization)

Get LookupList Values

CreateDocument ([Optional]string X-Authorization, [Optional]CreateDocumentParameterBody body)

Create Document

CopyDocument ([Optional]string X-Authorization, [Optional]CopyDocumentParameterBody body)

Copy Document

GetDocumentStatus ([Optional]string X-Authorization, [Optional]array body)

Get Document Status

MergePDF ([Optional]string X-Authorization, [Optional]array body)

Merge PDF's

DocumentReindex ([Optional]string X-Authorization, [Optional]DocumentReindexParameterBody body)

Document Reindex

DocumentSearch ([Optional]string X-Authorization, [Optional]DocumentSearchParameterBody body)

Document Search

TaxsortDocument ([Optional]string X-Authorization, [Optional]array body)

Taxsort Document

DocumentDelete (string documentId, [Optional]string X-Authorization)

Delete Document

GetDocument (string documentId, [Optional]string X-Authorization)

Get Document

GetDocumentHistory (string documentId, [Optional]string X-Authorization)

Get Document History

GetDocumentIndexes (string documentId, [Optional]string X-Authorization)

Get Document Indexes

PublishDocumentStatus (string documentId, [Optional]string X-Authorization, [Optional]PublishDocumentStatusParameterBody body)

Publish Document Status

GetDrawers ([Optional]string X-Authorization)

Get Drawers

GetDrawerIndexes (string drawerId, [Optional]string X-Authorization)

Get Drawer Indexes

GetFirmFlowDeliverableReport ([Optional]string X-Authorization, [Optional]GetFirmFlowDeliverableReportParameterBody body)

Get FirmFlow Data by Deliverable

ValidateIndexes ([Optional]string X-Authorization, [Optional]ValidateIndexesParameterBody body)

Validate Indexes

GetDynamicRulesForIndex (string indexId, [Optional]string X-Authorization)

Get Dynamic Rules for Index

IndexLookupListFind (string indexId, [Optional]string X-Authorization, [Optional]IndexLookupListFindParameterBody body)

Index LookupList Find

GetListTypeIndexData (string indexId, [Optional]string X-Authorization)

Get List of Index Values

GetChildIndexes (string indexId, string listId, [Optional]string X-Authorization)

Get Child Indexes

Login (LoginParameterBody body)

Login

Logout ([Optional]string X-Authorization)

Logout

ValidateToken ([Optional]string X-Authorization)

Validate Token

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CopyDocumentParameterBody

 

CopyDocumentResponseItem

 

CreateDocumentParameterBody

 

CreateDocumentResponse

 

CreateGroupParameterBody

 

CreateGroupResponse

 

CreateUsersParameterBody

 

CreateUsersResponse

 

DeleteUserParameterBody

 

DeleteUserResponse

 

DocumentDeleteResponseItem

 

DocumentReindexParameterBody

 

DocumentReindexResponseItem

 

DocumentSearchParameterBody

 

DocumentSearchResponse

 

GetChildIndexesResponseItem

 

GetDocumentHistoryResponse

 

GetDocumentIndexesResponseItem

 

GetDocumentResponse

 

GetDocumentStatusResponseItem

 

GetDrawerIndexesResponseItem

 

GetDrawersResponseItem

 

GetDynamicRulesForIndexResponseItem

 

GetFirmFlowDeliverableReportParameterBody

 

GetFirmFlowDeliverableReportResponse

 

GetGroupDocumentSecurityResponse

 

GetGroupPermissionsResponse

 

GetGroupsResponseItem

 

GetLicensesResponse

 

GetListOfReportsResponse

 

GetListTypeIndexDataResponseItem

 

GetLookupListResponseItem

 

GetPasswordPolicyResponse

 

GetUploadLocationResponse

 

GetUserDocumentSecurityResponse

 

GetUserInfoParameterBody

 

GetUserInfoResponse

 

GetUserPermissionResponse

 

GetUsersResponseItem

 

IndexLookupListFindParameterBody

 

IndexLookupListFindResponseItem

 

LoginParameterBody

 

LoginResponse

 

LogoutResponse

 

ModifyGroupParameterBody

 

ModifyGroupResponse

 

ModifyUserParameterBody

 

ModifyUserResponse

 

PublishDocumentStatusParameterBody

 

PublishDocumentStatusResponseItem

 

SetGroupDocSecurityParameterBody

 

SetGroupDocSecurityResponse

 

SetGroupPermissionsParameterBody

 

SetGroupPermissionsResponse

 

SetUserDocSecurityParameterBody

 

SetUserDocSecurityResponse

 

SetUserPermissionsParameterBody

 

SetUserPermissionsResponse

 

TaxsortDocumentResponseItem

 

ValidateIndexesParameterBody

 

ValidateIndexesResponse

 

 

Actions:

CreateGroup

Summary: Create Group

Description: Creates permission group

 

Syntax:

GoFileRoom.CreateGroup ([Optional]string X-Authorization, [Optional]CreateGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

CreateGroupParameterBody

 

 

False

 

Returns:

          Type:CreateGroupResponse

 

SetGroupDocSecurity

Summary: Set Group Document Security

Description: Assigns document security to a group

 

Syntax:

GoFileRoom.SetGroupDocSecurity ([Optional]string X-Authorization, [Optional]SetGroupDocSecurityParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

SetGroupDocSecurityParameterBody

 

 

False

 

Returns:

          Type:SetGroupDocSecurityResponse

 

ModifyGroup

Summary: Modify Group

Description: Modify group permissions

 

Syntax:

GoFileRoom.ModifyGroup ([Optional]string X-Authorization, [Optional]ModifyGroupParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

ModifyGroupParameterBody

 

 

False

 

Returns:

          Type:ModifyGroupResponse

 

GetGroupPermissions

Summary: Get Group Permissions

Description: Gets permissions of groups

 

Syntax:

GoFileRoom.GetGroupPermissions ([Optional]string groupName, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupName

string

(GroupName)

Enter Group Name

False

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetGroupPermissionsResponse

 

SetGroupPermissions

Summary: Set Group Permissions

Description: Assigns permission to group

 

Syntax:

GoFileRoom.SetGroupPermissions ([Optional]string X-Authorization, [Optional]SetGroupPermissionsParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

SetGroupPermissionsParameterBody

 

 

False

 

Returns:

          Type:SetGroupPermissionsResponse

 

GetGroupDocumentSecurity

Summary: Get Group Document Security

Description: Retrieve group document security

 

Syntax:

GoFileRoom.GetGroupDocumentSecurity (string groupName, string cabinetName, string drawerName, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

groupName

string

(GroupName)

Enter Group Name

True

cabinetName

string

(CabinetName)

Enter Cabinet Name

True

drawerName

string

(DrawerName)

Enter Drawer Name

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetGroupDocumentSecurityResponse

 

GetGroups

Summary: Get Groups

Description: Fetches the groups available for user and group management

 

Syntax:

GoFileRoom.GetGroups ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetGroupsResponseItem)

 

CreateUsers

Summary: Create Users

Description: Creates GoFileRoom and ClientFlow users into the System

 

Syntax:

GoFileRoom.CreateUsers ([Optional]string userType, [Optional]string X-Authorization, [Optional]CreateUsersParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

userType

string

(UserType)Values: [GFRUSERS]

Enter User Type

False

X-Authorization

string

(Token)

Token Authentication

False

body

CreateUsersParameterBody

 

 

False

 

Returns:

          Type:CreateUsersResponse

 

DeleteUser

Summary: Delete User

Description: Delete GoFileRoom and ClientFlow users from the System

 

Syntax:

GoFileRoom.DeleteUser ([Optional]string X-Authorization, [Optional]DeleteUserParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

DeleteUserParameterBody

 

 

False

 

Returns:

          Type:DeleteUserResponse

 

SetUserDocSecurity

Summary: Set User Document Security

Description: Assigns user document security permissions

 

Syntax:

GoFileRoom.SetUserDocSecurity ([Optional]string X-Authorization, [Optional]SetUserDocSecurityParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

SetUserDocSecurityParameterBody

 

 

False

 

Returns:

          Type:SetUserDocSecurityResponse

 

GetUserInfo

Summary: Get User Info

Description: Fetches the GFR User Information

 

Syntax:

GoFileRoom.GetUserInfo ([Optional]string X-Authorization, [Optional]GetUserInfoParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

GetUserInfoParameterBody

 

 

False

 

Returns:

          Type:GetUserInfoResponse

 

GetLicenses

Summary: Get Licenses

Description: Retrieves licensing counts

 

Syntax:

GoFileRoom.GetLicenses ([Optional]string license, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

license

string

(LicenseType)Values: [DEDICATED, CONCURRENT, FIRMFLOW]

Enter License Type

False

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetLicensesResponse

 

ModifyUser

Summary: Modify User

Description: Modify user permissions

 

Syntax:

GoFileRoom.ModifyUser ([Optional]string userType, [Optional]string X-Authorization, [Optional]ModifyUserParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

userType

string

(UserType)Values: [GFRUSERS, CLIENTFLOWUSERS]

Enter User Type

False

X-Authorization

string

(Token)

Token Authentication

False

body

ModifyUserParameterBody

 

 

False

 

Returns:

          Type:ModifyUserResponse

 

GetPasswordPolicy

Summary: Get Password Policy

Description: Fetches the Password policy for the firm

 

Syntax:

GoFileRoom.GetPasswordPolicy ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetPasswordPolicyResponse

 

SetUserPermissions

Summary: Set User Permissions

Description: Assigns permission to user

 

Syntax:

GoFileRoom.SetUserPermissions ([Optional]string X-Authorization, [Optional]SetUserPermissionsParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

SetUserPermissionsParameterBody

 

 

False

 

Returns:

          Type:SetUserPermissionsResponse

 

GetListOfReports

Summary: Get List of Reports

Description: Fetches the reports available for user management

 

Syntax:

GoFileRoom.GetListOfReports ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetListOfReportsResponse

 

GetUploadLocation

Summary: Get Upload Locations

Description: Fetches the upload locations for the user

 

Syntax:

GoFileRoom.GetUploadLocation ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetUploadLocationResponse

 

GetUserDocumentSecurity

Summary: Get User Document Security

Description: Fetches user document security per login

 

Syntax:

GoFileRoom.GetUserDocumentSecurity (string loginId, string cabinetName, string drawerName, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

loginId

string

(LoginId)

Enter Login ID

True

cabinetName

string

(CabinetName)

Enter Cabinet Name

True

drawerName

string

(DrawerName)

Enter Drawer Name

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetUserDocumentSecurityResponse

 

GetUserPermission

Summary: Get User Permissions

Description: Gets permissions of user

 

Syntax:

GoFileRoom.GetUserPermission (string login, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

login

string

(Login)

Enter Login

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetUserPermissionResponse

 

GetUsers

Summary: Get Users

Description: Fetches the GFR users for the Logged in User

 

Syntax:

GoFileRoom.GetUsers ([Optional]string userType, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

userType

string

(UserType)Values: [GFRUSERS, CLIENTFLOWUSERS]

Enter User Type

False

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetUsersResponseItem)

 

GetLookupList

Summary: Get LookupList Values

Description: Fetches the values from the LookupList

 

Syntax:

GoFileRoom.GetLookupList (string drawerId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

drawerId

string

(Drawer ID. Example Clients Drawer: "0000000001")

Enter Drawer ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetLookupListResponseItem)

 

CreateDocument

Summary: Create Document

Description: Creates a document record with indexes

 

Syntax:

GoFileRoom.CreateDocument ([Optional]string X-Authorization, [Optional]CreateDocumentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

CreateDocumentParameterBody

 

 

False

 

Returns:

          Type:CreateDocumentResponse

 

CopyDocument

Summary: Copy Document

Description: Copies the documents

 

Syntax:

GoFileRoom.CopyDocument ([Optional]string X-Authorization, [Optional]CopyDocumentParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

CopyDocumentParameterBody

 

 

False

 

Returns:

          Type:array of (CopyDocumentResponseItem)

 

GetDocumentStatus

Summary: Get Document Status

Description: Get the Status of Documents

 

Syntax:

GoFileRoom.GetDocumentStatus ([Optional]string X-Authorization, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

array of (string)

 

 

False

 

Returns:

          Type:array of (GetDocumentStatusResponseItem)

 

MergePDF

Summary: Merge PDF's

Description: Merge PDF files together

 

Syntax:

GoFileRoom.MergePDF ([Optional]string X-Authorization, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

array of (string)

 

 

False

 

Returns:

          Type:string

 

DocumentReindex

Summary: Document Reindex

Description: Reindexes the documents

 

Syntax:

GoFileRoom.DocumentReindex ([Optional]string X-Authorization, [Optional]DocumentReindexParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

DocumentReindexParameterBody

 

 

False

 

Returns:

          Type:array of (DocumentReindexResponseItem)

 

DocumentSearch

Summary: Document Search

Description: Loads all the documents the user has access to in the specified drawer.

 

Syntax:

GoFileRoom.DocumentSearch ([Optional]string X-Authorization, [Optional]DocumentSearchParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

DocumentSearchParameterBody

 

 

False

 

Returns:

          Type:DocumentSearchResponse

 

TaxsortDocument

Summary: Taxsort Document

Description: Taxsort PDF document

 

Syntax:

GoFileRoom.TaxsortDocument ([Optional]string X-Authorization, [Optional]array body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

array of (string)

 

 

False

 

Returns:

          Type:array of (TaxsortDocumentResponseItem)

 

DocumentDelete

Summary: Delete Document

Description: Deletes a document

 

Syntax:

GoFileRoom.DocumentDelete (string documentId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

documentId

string

(DocumentId)

Enter Document ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (DocumentDeleteResponseItem)

 

GetDocument

Summary: Get Document

Description: Downloads the document

 

Syntax:

GoFileRoom.GetDocument (string documentId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

documentId

string

(DocumentId)

Enter Document ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetDocumentResponse

 

GetDocumentHistory

Summary: Get Document History

Description: Gets the history of the document

 

Syntax:

GoFileRoom.GetDocumentHistory (string documentId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

documentId

string

(DocumentId)

Enter Document ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:GetDocumentHistoryResponse

 

GetDocumentIndexes

Summary: Get Document Indexes

Description: Retrieves the document's indexes

 

Syntax:

GoFileRoom.GetDocumentIndexes (string documentId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

documentId

string

(DocumentId)

Enter Document ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetDocumentIndexesResponseItem)

 

PublishDocumentStatus

Summary: Publish Document Status

Description: Publish or Unpublish documents from ClientFlow.

 

Syntax:

GoFileRoom.PublishDocumentStatus (string documentId, [Optional]string X-Authorization, [Optional]PublishDocumentStatusParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

documentId

string

(DocumentId)

Enter Document Id

True

X-Authorization

string

(Token)

Token Authentication

False

body

PublishDocumentStatusParameterBody

 

 

False

 

Returns:

          Type:array of (PublishDocumentStatusResponseItem)

 

GetDrawers

Summary: Get Drawers

Description: Fetches the drawers accessible for the Logged in User

 

Syntax:

GoFileRoom.GetDrawers ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetDrawersResponseItem)

 

GetDrawerIndexes

Summary: Get Drawer Indexes

Description: Retrieves a list of document indexes that are set up for the drawer

 

Syntax:

GoFileRoom.GetDrawerIndexes (string drawerId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

drawerId

string

(DrawerId)

Enter Drawer ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetDrawerIndexesResponseItem)

 

GetFirmFlowDeliverableReport

Summary: Get FirmFlow Data by Deliverable

Description: Gets the Tracking Report by Deliverable data

 

Syntax:

GoFileRoom.GetFirmFlowDeliverableReport ([Optional]string X-Authorization, [Optional]GetFirmFlowDeliverableReportParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

GetFirmFlowDeliverableReportParameterBody

 

 

False

 

Returns:

          Type:GetFirmFlowDeliverableReportResponse

 

ValidateIndexes

Summary: Validate Indexes

Description: Checks whether the indexes provided are valid.

 

Syntax:

GoFileRoom.ValidateIndexes ([Optional]string X-Authorization, [Optional]ValidateIndexesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

body

ValidateIndexesParameterBody

 

 

False

 

Returns:

          Type:ValidateIndexesResponse

 

GetDynamicRulesForIndex

Summary: Get Dynamic Rules for Index

Description: Gets the list of dynamic rules configured for the specified index

 

Syntax:

GoFileRoom.GetDynamicRulesForIndex (string indexId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

indexId

string

(IndexId)

Enter Index ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetDynamicRulesForIndexResponseItem)

 

IndexLookupListFind

Summary: Index LookupList Find

Description: This method is designed for use with autocomplete fields.

 

Syntax:

GoFileRoom.IndexLookupListFind (string indexId, [Optional]string X-Authorization, [Optional]IndexLookupListFindParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

indexId

string

(IndexID)

Enter Index ID

True

X-Authorization

string

(Token)

Token Authentication

False

body

IndexLookupListFindParameterBody

 

 

False

 

Returns:

          Type:array of (IndexLookupListFindResponseItem)

 

GetListTypeIndexData

Summary: Get List of Index Values

Description: Gets all the entries for a list type index

 

Syntax:

GoFileRoom.GetListTypeIndexData (string indexId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

indexId

string

(IndexId)

Enter Index ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetListTypeIndexDataResponseItem)

 

GetChildIndexes

Summary: Get Child Indexes

Description: Gets a list of child index values based on the list ID, which is provided when the parent list value is selected.

 

Syntax:

GoFileRoom.GetChildIndexes (string indexId, string listId, [Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

indexId

string

(IndexId)

Enter Index ID

True

listId

string

(ListId)

Enter List ID

True

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:array of (GetChildIndexesResponseItem)

 

Login

Summary: Login

Description: Logs a user into the application

 

Syntax:

GoFileRoom.Login (LoginParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

LoginParameterBody

 

 

True

 

Returns:

          Type:LoginResponse

 

Logout

Summary: Logout

Description: Logout of application

 

Syntax:

GoFileRoom.Logout ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:LogoutResponse

 

ValidateToken

Summary: Validate Token

Description: Validate Token status

 

Syntax:

GoFileRoom.ValidateToken ([Optional]string X-Authorization)

 

Parameters:

Name

Type

Summary

Required

Related Action

X-Authorization

string

(Token)

Token Authentication

False

 

Returns:

          Type:boolean

 


 

CopyDocumentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DocumentIds

array of (string)

 

DocumentIds

IndexValues

array of (IndexValuesItem)

 

IndexValues

 

IndexValuesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

IndexId

string

 

Enter Index Id

IndexValue

string

 

Enter Index Value

 


 

CopyDocumentResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

copyDocumentException

string

 

copy Document Exception

documentId

string

 

document Id value

isCopied

boolean

 

Did the document get copied

newDocumentId

string

 

new Document Id


 

CreateDocumentParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DrawerId

string

 

Enter Drawer Id

Indexes

array of (IndexesItem)

 

Indexes

 

IndexesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

IndexId

string

 

Enter Index Id

IndexValue

string

 

Enter Index Value

 


 

CreateDocumentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentCreate

DocumentCreate

 

documentCreate

indexValidation

IndexValidation

 

indexValidation

 

DocumentCreate

Summary:

Description: documentCreate

 

          Properties:

Name

Type

Summary

documentId

string

 

document Id value

errorMessage

string

 

error message

 

IndexValidation

Summary:

Description: indexValidation

 

          Properties:

Name

Type

Summary

errorMessage

string

 

error message

errors

array of (ErrorsItem)

 

errors

isValid

boolean

 

is document valid

 

ErrorsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

CreateGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

AccessToApproveDocsOnly

string

 

Specify true or false

AllowAccessToReports

string

 

Specify true or false

Comments

string

 

Enter Comments

EnableMfa

string

 

Specify true or false

EnforceMfaForUsers

string

 

Specify true or false

FirmFlowRoutingNotification

string

 

Specify true or false

FullAccessToDocTracking

string

 

Specify true or false

GroupName

string

 

Enter Group Name

MfaRequired

string

 

Specify true or false

PermissonToApproveDocs

string

 

Specify true or false

Reports

array of (ReportsItem)

 

Reports

UploadLocation

string

 

Enter Upload Location

Users

array of (string)

 

Users

 

ReportsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Allow

array of (string)

 

Allow

Deny

array of (string)

 

Deny

IsAllowAll

string

 

Specify true or false

IsDenyAll

string

 

Specify true or false

ReportType

string

 

Specify true or false

 


 

CreateGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

createGroupException

string

 

create Group Exception

groupId

string

 

group Id value

isCreated

boolean

 

Did the group get created

mfaException

string

 

mfa status


 

CreateUsersParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

AccountExpiresDate

string

 

Enter Account Expires Date

DisabledComments

string

 

Enter Disabled Comments

FullName

string

 

User Full Name

Groups

array of (string)

 

Groups

IsAccountExpires

string

 

Specify true or false

IsAdvanceFlow

string

 

Specify true or false

IsAllowAccessToReports

string

 

Specify true or false

IsAllowOffline

string

 

Specify true or false

IsDisabled

string

 

Specify true or false

IsFirmFlow

string

 

Specify true or false

IsFirmFlowNotificationGroup

string

 

Specify true or false

IsFirmFlowNotificationUser

string

 

Specify true or false

IsMfa

string

 

Specify true or false

IsUserAdministration

string

 

Specify true or false

IsWorkflowManagerUser

string

 

Specify true or false

LicenseType

string

 

Enter License Type

LoginName

string

 

Enter Login Name

ManagerEmail

string

 

Enter Manager Email

Password

string

 

Enter Password

Reports

array of (ReportsItem)

 

Reports

UploadLocation

string

 

Enter Upload Location

 

ReportsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Allow

array of (string)

 

Allow

Deny

array of (string)

 

Deny

IsAllowAll

string

 

Specify true or false

IsDenyAll

string

 

Specify true or false

ReportType

string

 

Specify true or false

 


 

CreateUsersResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

createUserException

string

 

create User Exception

isCreated

boolean

 

Did the user get created

mfaException

string

 

mfa Exception

userId

string

 

user Id value


 

DeleteUserParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

LoginId

string

 

Enter the Login Id of the user

UserType

string

 

Enter the User Type  Values: [GFRUSERS, CLIENTFLOWUSERS]


 

DeleteUserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

deleteUserException

string

 

delete User Exception

isDeleted

boolean

 

Did the login get Deleted

loginId

string

 

login Id value


 

DocumentDeleteResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

deleteDocumentException

string

 

delete Document Exception

documentId

string

 

document Id value

isDeleted

boolean

 

is the document deleted


 

DocumentReindexParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DocumentIds

array of (string)

 

DocumentIds

IndexValues

array of (IndexValuesItem)

 

IndexValues

 

IndexValuesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

IndexId

string

 

Enter Index Id

IndexValue

string

 

Enter Index Value

 


 

DocumentReindexResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentId

string

 

document Id value

isReIndexed

boolean

 

is the document ReIndexed

reIndexDocumentException

string

 

reIndex Document Exception


 

DocumentSearchParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DrawerId

string

 

Enter Drawer Id

Filter

Filter

 

Filter

NumberOfRows

integer(int32)

 

Enter Number Of Rows

PageNumber

integer(int32)

 

Enter Page Number

SortField

string

 

Enter Sort Field

SortOrder

string

 

Enter Sort Order  Values: [ASC, DESC]

 

Filter

Summary:

Description: Filter

 

          Properties:

Name

Type

Summary

IndexValues

array of (IndexValuesItem)

 

IndexValues

 

IndexValuesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

IndexId

string

 

Enter Index Id

IndexValue

string

 

Enter Index Value

 


 

DocumentSearchResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentIds

array of (string)

 

documentIds

documentSearchCount

integer(int32)

 

document Search Count


 

GetChildIndexesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

childIndexId

string

 

child Index Id value

childListId

integer(int32)

 

child List Id value

hasChildren

boolean

 

Does the index have a child index

listEntryId

integer(int32)

 

list Entry Id value

listId

integer(int32)

 

list Id value

value

string

 

value


 

GetDocumentHistoryResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentAudit

array of (DocumentAuditItem)

 

documentAudit

documentHistoryException

string

 

document History Exception

documentId

string

 

document Id value

mergeDocHistory

array of (MergeDocHistoryItem)

 

mergeDocHistory

 

DocumentAuditItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

MergeDocHistoryItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetDocumentIndexesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

indexId

string

 

index Id value

indexValue

string

 

index Value


 

GetDocumentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetDocumentStatusResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentId

string

 

document Id value

documentStatusException

string

 

document Status Exception

drawerId

string

 

drawer Id value

fileSize

string

 

file Size value

isArchived

boolean

 

is the document Archived

isCheckedOut

boolean

 

is the document Checked Out

isEncrypted

boolean

 

is the document Encrypted

isFiled

boolean

 

is the document Filed

isInRedactionQueue

boolean

 

is the document In the Redaction Queue

isInTaxsortQueue

boolean

 

is the document In the Taxsort Queue

isLocked

boolean

 

is the document Locked

isOfficeDocument

boolean

 

is the document an Office Document

isPublished

boolean

 

is the document Published

isUndergoingMerging

boolean

 

is the document Undergoing Merging

localFile

string

 

is the document a local file

noEdit

boolean

 

no Edit value

pages

integer(int32)

 

pages in document

reviewed

boolean

 

reviewed status

taxSort

boolean

 

is the document taxSorted

type

string

 

type of file

version

integer(int32)

 

version of document


 

GetDrawerIndexesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

childIndexId

string

 

child Index Id value

indexId

string

 

index Id value

indexName

string

 

index Name value

indexType

string

 

index Type value

length

integer(int32)

 

Drawer Index length

listId

integer(int32)

 

list Id value

lookupAutoUpdate

boolean

 

lookup Auto Update

required

boolean

 

Is the index required


 

GetDrawersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

drawerID

string

 

drawer ID value

drawerName

string

 

drawer Name value

permissions

Permissions

 

permissions

 

Permissions

Summary:

Description: permissions

 

          Properties:

Name

Type

Summary

add

boolean

 

add value

delete

boolean

 

delete value

edit

boolean

 

edit value

lookupManagement

boolean

 

lookupManagement value

view

boolean

 

view value

 


 

GetDynamicRulesForIndexResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

condition

string

 

condition value

dependentIndexId

string

 

dependent Index Id value

dynamicRuleId

string

 

dynamic Rule Id value

value

string

 

value


 

GetFirmFlowDeliverableReportParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Accountable

string

 

Enter Accountable value

AssignedOn

string

 

Enter Assigned On Date

AssignedTo

string

 

Enter Assigned To value

AssignmentHistory

string

 

Enter Assignment History

CompletedBy

string

 

Enter Completed By value

CompletedOn

string

 

Enter Completed On Date

CurrentDueDate

string

 

Enter Current Due Date

CurrentStep

string

 

Enter Current Step

DateExtended

string

 

Enter Date Extended

DaysAtStep

string

 

Enter Days At Step

DaysBetweenRoutings

string

 

Enter Days Between Routings

DrawerId

string

 

Enter Drawer Id

EngagementType

string

 

Enter Engagement Type

InProcessOnly

string

 

Enter In Process Only value

Indexes

array of (string)

 

Indexes

InformationFields

array of (string)

 

InformationFields

OriginalDueDate

string

 

Enter Original Due Date

PIC

string

 

Enter PIC

PageNumber

string

 

Enter Page Number

Priority

string

 

Enter Priority

ReceivedFrom

string

 

Enter Received From value

ReceivedOn

string

 

Enter Received On Date

Responsible

string

 

Enter Responsible value

RoutingDetails

string

 

Enter Routing Details

SentOn

string

 

Enter Sent On Date

SentTo

string

 

Enter Sent To value

ServiceType

string

 

Enter Service Type

Status

string

 

Enter Status

TotalDaysAtStep

string

 

Enter Total Days At Step

TotalDaysInProcess

string

 

Enter Total Days In Process

Workflow

string

 

Enter Workflow name

WorkflowDescription

string

 

Enter Workflow Description


 

GetFirmFlowDeliverableReportResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

firmFlowReportResponse

array of (FirmFlowReportResponseItem)

 

firmFlowReportResponse

getFirmFlowException

string

 

get FirmFlow Exception

pageNumber

string

 

page Number of request

pageSize

integer(int32)

 

page Size of request

totalPages

integer(int32)

 

total Pages of request

totalRecords

integer(int32)

 

total Records of request

 

FirmFlowReportResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

accountable

string

 

accountable value

assignedOn

string

 

assigned On date

assignedTo

string

 

assigned To value

assignedToYesOrNo

string

 

Is the workflow assigned

assignmentHistory

string

 

assignment History value

clientName

string

 

client Name value

clientNumber

string

 

client Number value

completedBy

string

 

completed By value

completedOn

string

 

completed On date

currentDueDate

string

 

current Due Date

currentStep

string

 

current Step value

dateExtended

string

 

date Extended

daysAtStep

string

 

workflow days At Step

daysBetweenRoutings

string

 

workflow days Between Routings

deliverables

string

 

deliverables value

drawerId

string

 

drawer Id value

eFileYesOrNo

string

 

is the deliverable to be eFiled

engagementType

string

 

engagement Type value

extendedYesOrNo

string

 

has the deliverable been extended

informationFields

array of (InformationFieldsItem)

 

informationFields

originalDueDate

string

 

original Due Date

periodEnd

string

 

period End of workflow

pic

string

 

pic of workflow

picYesOrNo

string

 

has the pic been assigned

priority

string

 

priority value

progress

string

 

progress value

receivedFrom

string

 

received From value

receivedOn

string

 

received On date

responsible

string

 

responsible value

responsibleUserOrGroups

array of (ResponsibleUserOrGroupsItem)

 

responsibleUserOrGroups

routingNotes

string

 

routing Notes of workflow

routingSummary

array of (RoutingSummaryItem)

 

routingSummary

sentOn

string

 

sent On date

sentTo

string

 

sent To value

serviceType

string

 

service Type of workflow

status

string

 

status of workflow

totalDaysAtStep

string

 

workflow total Days At Step

totalDaysInProcess

string

 

workflow total Days In Process

workflow

string

 

workflow type

workflowDescription

string

 

workflow Description

year

string

 

year of workflow

 

InformationFieldsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

name

value

string

 

value

 

ResponsibleUserOrGroupsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 

RoutingSummaryItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetGroupDocumentSecurityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cabinetName

string

 

Cabinet Name value

documentSecurity

string

 

Document Security value

drawerName

string

 

Drawer Name value

getGroupDocSecurityException

string

 

Group Document Security Exception

groupName

string

 

Group Name value


 

GetGroupPermissionsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cabinet

string

 

Cabinet Name

cabinetPermissions

CabinetPermissions

 

cabinetPermissions

drawerPermissions

array of (DrawerPermissionsItem)

 

drawerPermissions

groupName

string

 

Group Name

groupPermissionException

string

 

Group Permission Exception

 

CabinetPermissions

Summary:

Description: cabinetPermissions

 

          Properties:

Name

Type

Summary

add

boolean

 

add permissions

delete

boolean

 

delete permissions

deny

boolean

 

deny permissions

edit

boolean

 

edit permissions

lookUp

boolean

 

lookUp permissions

read

boolean

 

read permissions

 

DrawerPermissionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

drawer

string

 

Drawer Name

permission

Permission

 

permission

 

Permission

Summary:

Description: permission

 

          Properties:

Name

Type

Summary

add

boolean

 

add permissions

delete

boolean

 

delete permissions

deny

boolean

 

deny permissions

edit

boolean

 

edit permissions

lookUp

boolean

 

lookUp permissions

read

boolean

 

read permissions

 


 

GetGroupsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Group ID value

mfa

integer(int32)

 

mfa value

mfaRequired

integer(int32)

 

mfa Required value

name

string

 

Group name value


 

GetLicensesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

assignedLicenses

string

 

assigned License count

getLicenseException

string

 

get License Exception

license

string

 

license name

message

string

 

message

totalLicenses

string

 

total license count


 

GetListOfReportsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

reports

array of (ReportsItem)

 

reports

reportsException

string

 

reports Exception value

 

ReportsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

reportName

array of (string)

 

reportName

reportType

string

 

report Type value

 


 

GetListTypeIndexDataResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

childIndexId

string

 

child Index Id value

childListId

integer(int32)

 

child List Id value

hasChildren

boolean

 

Does the index have a child index

listEntryId

integer(int32)

 

list Entry Id value

listId

integer(int32)

 

list Id value

value

string

 

value


 

GetLookupListResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

clientName

string

 

client Name value

clientNumber

string

 

client number value


 

GetPasswordPolicyResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

passwordPolicy

PasswordPolicy

 

passwordPolicy

passwordPolicyException

string

 

passwordPolicyException

 

PasswordPolicy

Summary:

Description: passwordPolicy

 

          Properties:

Name

Type

Summary

clientId

string

 

client Id value

forbidden_pwd_words

array of (string)

 

forbidden_pwd_words

lockout_threshold

integer(int32)

 

lockout threshold

max_length

integer(int32)

 

max length of password

max_login_similarity

string

 

maximum login similarity

max_pwd_age

integer(int32)

 

max pwd age  of password

max_repeat_chars

string

 

max repeat chars in password

max_sequential_chars

string

 

maximum sequential characters

mfa

integer(int32)

 

mfa value

min_length

integer(int32)

 

min length of password

pwd_req_alpha

integer(int32)

 

Alpha Password Requirement

pwd_req_lower

integer(int32)

 

Lower Password Requirement

pwd_req_number

integer(int32)

 

Password Number Requirement

pwd_req_symbol

integer(int32)

 

Symbol Password Requirement

pwd_req_upper

integer(int32)

 

Upper Password Requirement

 


 

GetUploadLocationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

uploadLocations

array of (UploadLocationsItem)

 

uploadLocations

uploadLocationsException

string

 

upload Locations Exception

 

UploadLocationsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

locationName

string

 

location Name value

locationPath

string

 

location Path value

 


 

GetUserDocumentSecurityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cabinetName

string

 

cabinet Name

documentSecurity

string

 

document Security value

drawerName

string

 

drawer name value

getUserDocSecurityException

string

 

User Document Security Exception

loginId

string

 

login Id value


 

GetUserInfoParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

LoginName

string

 

Enter LoginName

UserType

string

 

Select UserType


 

GetUserInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

createDate

string

 

createDate

createdBy

string

 

createdBy

description

string

 

description

disabled

integer(int32)

 

disabled

disabledByAdmin

boolean

 

disabledByAdmin

emailNotify

boolean

 

emailNotify

emailNotifyEventMgmtGroups

boolean

 

emailNotifyEventMgmtGroups

emailNotifyEventMgmtUsers

boolean

 

emailNotifyEventMgmtUsers

emailNotifyGroup

boolean

 

emailNotifyGroup

forcePasswordChange

boolean

 

forcePasswordChange

fullName

string

 

fullName

hasDrawerSetupRights

string

 

hasDrawerSetupRights

isAdmin

integer(int32)

 

isAdmin

isManager

integer(int32)

 

isManager

licenseType

string

 

licenseType

locationID

string

 

locationID

loginID

string

 

loginID

managerFullName

string

 

managerFullName

managerId

string

 

managerId

managerLoginId

string

 

managerLoginId

oberonUser

integer(int32)

 

oberonUser

offline

boolean

 

offline

passwordChangeDate

string

 

passwordChangeDate

passwordChangeInterval

integer(int32)

 

passwordChangeInterval

passwordExpireDate

string

 

passwordExpireDate

reports

boolean

 

reports

signature

string

 

signature

systemAdmin

boolean

 

systemAdmin

taxFlow

boolean

 

taxFlow

userAdministration

integer(int32)

 

userAdministration

userID

string

 

userID

workflowManagerUser

boolean

 

workflowManagerUser


 

GetUserPermissionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

cabinet

string

 

cabinet name value

cabinetPermission

CabinetPermission

 

cabinetPermission

drawerPermissions

array of (DrawerPermissionsItem)

 

drawerPermissions

getUserPermissionException

string

 

User Permission Exception

loginId

string

 

login Id value

 

CabinetPermission

Summary:

Description: cabinetPermission

 

          Properties:

Name

Type

Summary

add

boolean

 

add value

delete

boolean

 

delete value

deny

boolean

 

deny value

edit

boolean

 

edit value

lookUp

boolean

 

lookUp value

read

boolean

 

read value

 

DrawerPermissionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

drawer

string

 

drawer name value

permission

Permission

 

permission

 

Permission

Summary:

Description: permission

 

          Properties:

Name

Type

Summary

add

boolean

 

add value

delete

boolean

 

delete value

deny

boolean

 

deny value

edit

boolean

 

edit value

lookUp

boolean

 

lookUp value

read

boolean

 

read value

 


 

GetUsersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

isActive

boolean

 

Is the user Active

loginId

string

 

login Id value


 

IndexLookupListFindParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ActionType

integer

 

Enter Action Type  Values: [, , , , , ]

Count

integer(int32)

 

Enter Count

IndexValue

string

 

Enter Index Value

SearchType

integer

 

Enter Search Type  Values: [, , , ]


 

IndexLookupListFindResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

index

Index

 

index

linkedIndexes

array of (LinkedIndexesItem)

 

linkedIndexes

 

Index

Summary:

Description: index

 

          Properties:

Name

Type

Summary

indexId

string

 

index Id value

indexValue

string

 

index Value

 

LinkedIndexesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

indexId

string

 

indexId

indexValue

string

 

indexValue

 


 

LoginParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

LoginName

string

 

Enter Login Name

Password

string(password)

 

Enter Password


 

LoginResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

authSuccess

boolean

 

was authentication Successful

authenticationResponse

string

 

authentication Response value

customerId

string

 

customer Id value

errorCode

string

 

error Code value

idleSessionTimeoutMinutes

integer(int32)

 

idle Session Timeout Minutes

loneStarFirmId

string

 

lone Star Firm Id

loneStarValidated

boolean

 

lone Star Validated

token

string

 

token value

userId

string

 

user Id value

userName

string

 

user Name value


 

LogoutResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

isLogoutSuccess

boolean

 

Was the Logout Successful


 

ModifyGroupParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

AccessToApproveDocsOnly

string

 

Specify true or false

AllowAccessToReports

string

 

Specify true or false

Comments

string

 

Enter Comments

EnableMfa

string

 

Specify true or false

EnforceMfaForUsers

string

 

Specify true or false

FirmFlowRoutingNotification

string

 

Specify true or false

FullAccessToDocTracking

string

 

Specify true or false

GroupName

string

 

Enter Group Name

MfaRequired

string

 

Specify true or false

PermissonToApproveDocs

string

 

Specify true or false

RenameGroup

string

 

Enter New Group Name

Reports

array of (ReportsItem)

 

Reports

UploadLocation

string

 

Enter Upload Location

Users

array of (string)

 

Users

 

ReportsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Allow

array of (string)

 

Allow

Deny

array of (string)

 

Deny

IsAllowAll

string

 

Specify true or false

IsDenyAll

string

 

Specify true or false

ReportType

string

 

Specify true or false

 


 

ModifyGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupId

string

 

group Id value

isModified

boolean

 

Did the Group get Modified

mfaException

string

 

mfa Exception

modifyGroupException

string

 

modify Group Exception


 

ModifyUserParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

AccountExpiresDate

string

 

Date the Account will expire

DisabledComments

string

 

Enter Comments

FullName

string

 

Enter Full Name

Groups

array of (string)

 

Groups

IsAccountExpires

string

 

Specify true or false

IsAdvanceFlow

string

 

Specify true or false

IsAllowAccessToReports

string

 

Specify true or false

IsAllowOffline

string

 

Specify true or false

IsChangeNextLogin

string

 

Specify true or false

IsDisabled

string

 

Specify true or false

IsFirmFlow

string

 

Specify true or false

IsFirmFlowNotificationGroup

string

 

Specify true or false

IsFirmFlowNotificationUser

string

 

Specify true or false

IsMfa

string

 

Specify true or false

IsUserAdministration

string

 

Specify true or false

IsWorkflowManagerUser

string

 

Specify true or false

LicenseType

string

 

Enter License Type

LoginName

string

 

Enter Login Name

ManagerEmail

string

 

Enter Manager Email

Password

string

 

Enter Password

Reports

array of (ReportsItem)

 

Reports

UploadLocation

string

 

Enter Upload Location

 

ReportsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Allow

array of (string)

 

Allow

Deny

array of (string)

 

Deny

IsAllowAll

string

 

Specify true or false

IsDenyAll

string

 

Specify true or false

ReportType

string

 

Specify true or false

 


 

ModifyUserResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

isModified

boolean

 

Was the user modified

mfaException

string

 

mfa Exception

modifyUserException

string

 

modify User Exception

userId

string

 

user Id value


 

PublishDocumentStatusParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

IsPublished

string

 

Specify true or false


 

PublishDocumentStatusResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentException

string

 

document Exception

documentId

string

 

document Id value

isPublished

boolean

 

is the document Published


 

SetGroupDocSecurityParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

CabinetName

string

 

Enter the Cabinet Name

DocumentSecurity

array of (DocumentSecurityItem)

 

DocumentSecurity

DrawerName

string

 

Enter the Drawer Name

GroupName

string

 

Enter the Group Name

 

DocumentSecurityItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

DocSecurityType

string

 

Enter Document Security Type  Values: [DENY ACCESS, ALLOW ACCESS, NO EDIT]

IndexName

string

 

Enter the Index Name

Operation

string

 

Enter the Operation Type  Values: [ADD, REMOVE, CLEAR ALL]

Values

array of (string)

 

Values

 


 

SetGroupDocSecurityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupName

string

 

Group Name value

isSetGroupDocSecurity

boolean

 

Did Document Security get set

setGroupDocSecurityException

string

 

Group Document Security Exception


 

SetGroupPermissionsParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Cabinet

string

 

Enter Cabinet Name

CabinetPermission

CabinetPermission

 

CabinetPermission

DrawerPermissions

array of (DrawerPermissionsItem)

 

DrawerPermissions

GroupName

string

 

Enter Group Name

 

CabinetPermission

Summary:

Description: CabinetPermission

 

          Properties:

Name

Type

Summary

Add

string

 

Specify true or false

Delete

string

 

Specify true or false

Deny

string

 

Specify true or false

Edit

string

 

Specify true or false

LookUp

string

 

Specify true or false

Read

string

 

Specify true or false

 

DrawerPermissionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Drawer

string

 

Enter Drawer Name

Permission

Permission

 

Permission

 

Permission

Summary:

Description: Permission

 

          Properties:

Name

Type

Summary

Add

string

 

Specify true or false

Delete

string

 

Specify true or false

Deny

string

 

Specify true or false

Edit

string

 

Specify true or false

LookUp

string

 

Specify true or false

Read

string

 

Specify true or false

 


 

SetGroupPermissionsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupId

string

 

group Id value

groupPermissionException

string

 

group Permission Exception

isSet

boolean

 

Did permissions get applied


 

SetUserDocSecurityParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

CabinetName

string

 

Enter Cabinet Name

DocumentSecurity

array of (DocumentSecurityItem)

 

DocumentSecurity

DrawerName

string

 

Enter Drawer Name

LoginId

string

 

Enter Login Id

 

DocumentSecurityItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

DocSecurityType

string

 

Enter Document Security Type  Values: [DENY ACCESS, ALLOW ACCESS, NO EDIT]

IndexName

string

 

Enter Index Name

Operation

string

 

Enter Operation  Values: [ADD, REMOVE, CLEAR ALL]

Values

array of (string)

 

Values

 


 

SetUserDocSecurityResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

isSetUserDocSecurity

boolean

 

Did User Document Security get applied

loginId

string

 

login Id value

setUserDocSecurityException

string

 

set User Doc Security Exception


 

SetUserPermissionsParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

Cabinet

string

 

Enter Cabinet Name

CabinetPermission

CabinetPermission

 

CabinetPermission

DrawerPermissions

array of (DrawerPermissionsItem)

 

DrawerPermissions

LoginId

string

 

Enter Login Id

 

CabinetPermission

Summary:

Description: CabinetPermission

 

          Properties:

Name

Type

Summary

Add

string

 

Specify true or false

Delete

string

 

Specify true or false

Deny

string

 

Specify true or false

Edit

string

 

Specify true or false

LookUp

string

 

Specify true or false

Read

string

 

Specify true or false

 

DrawerPermissionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Drawer

string

 

Enter Drawer Name

Permission

Permission

 

Permission

 

Permission

Summary:

Description: Permission

 

          Properties:

Name

Type

Summary

Add

string

 

Specify true or false

Delete

string

 

Specify true or false

Deny

string

 

Specify true or false

Edit

string

 

Specify true or false

LookUp

string

 

Specify true or false

Read

string

 

Specify true or false

 


 

SetUserPermissionsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

isSetUserPermission

boolean

 

Did User Permission update

loginId

string

 

login Id value

setUserPermissionException

string

 

set User Permission Exception


 

TaxsortDocumentResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentId

string

 

document Id value

isTaxSorted

boolean

 

Is the document TaxSorted

taxsortDocumentException

string

 

taxsort Document Exception


 

ValidateIndexesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

DrawerId

string

 

Enter Drawer Id

Indexes

array of (IndexesItem)

 

Indexes

 

IndexesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

IndexId

string

 

Enter Index Id

IndexValue

string

 

Enter Index Value

 


 

ValidateIndexesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

errorMessage

string

 

error Message

errors

array of (ErrorsItem)

 

errors

isValid

boolean

 

is the index valid

 

ErrorsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary