Data structures

ServerVersionInfo

CODE

version: string
buildDate: string
buildTimeStamp: long

ErrorCodeInfo

CODE

errorCode: integer

CODE

current codes:
    0    OK
    1000 not implemented
    1001 output document error
    1002 delete document error
    1003 create user error
    1004 delete user error
    1005 enroll card error
    1006 account not found
    1007 object tree error
    1008 create account error
    1009 create output port error
    1010 create trigger error
    1011 delete trigger error
    1012 run automation error
    1013 update user error
    1014 register server error
    1015 create input port error
    1016 delete input port error
    1017 delete output port error
    1030 delete authentication provider error
    1031 save authentication provider error
    1032 no services for authentication provider error
    1040 save access control error
    1041 delete access control error
    1042 output not ready error
    1043 create group error
    1044 delete group error
    1050 license count exceeded
    1051 license expired
    1060 import users error
    1070 create terminal configuration error
    1080 delete account error
    1090 update account error
    10000 unknown error

ErrorCodeInfoId

CODE

errorCode: integer
id: integer

CODE

current codes: same as for ErrorCodeInfo

UserInfo

CODE

providerId: int
userName: string
fullName: string
email: string
token: TokenInfo

TokenInfo

CODE

access_token: string
refresh_token: string
expires_in: int

DocumentInfo

CODE

uuid: string
documentName: string
documentType: int
userName: string
totalPages: int
colorPages: int
duplex: int
copies: int
grayscale: boolean
paperSize: string

OutputPortInfo

CODE

id: int
name: string
address: string
portType: int
vendor: string
logoutTimeout: int
autoRelease: boolean
embedded: boolean
monochrome: boolean
trimCardId: boolean
description: string
embeddedConfigurationId: int
printProtocol: int
modelFamily: int
outputType: int
services: {
   string: [int, int, ...],
   ...
}
deviceSerial: string
properties: {
   string: string,
   ...
}
containerName: string

InputPortInfo

CODE

id: int
name: string
portType: int
outputPort: string (optional, may be null)
locationId: int (optional, may be null)
containerName: string (optional, may be null)

AccountInfo

CODE

id: int
name: string
accountType: int (1=vendor, 2=customer, 3=container)
domainNames: list of strings

ContainerInfo

CODE

id: int
name: string
domainNames: list of strings

LocationInfo

CODE

id: int
name: string
sortOrder: int
identifiers: list of LocationIdentifierSearch

LocationIdentifierSearch

CODE

locationType: LocationType (GATEWAY_IP, SUBNET, IP_RANGE, WIFI_SSID)
searchValue: string

GroupInfo

CODE

id: int
groupName: string
groupDN: string

TerminalConfig

CODE

"services": {
  "scanToMe": {
    "serviceId": "SCANTOMAIL",
    "enabled": boolean,
    "instanceIndex": 1,
    "smtp": {
      "server": string,
      "port": int,
      "security": {
        "mode": string, ("none", "tls", "start_tls")
        "disableCertificateCheck": boolean
      },
      "user": string,
      "password": string,
      "senderEmail": string,
      "disableUserAuthentication": boolean
    }
  },
  "print": {
    "serviceId": "PRINT",
    "enabled": boolean,
    "instanceIndex": 1
  },
  "printShortcut": {
    "serviceId": "SHPMCPRINT",
    "enabled": boolean
  },
  "sho365Shortcut": {
    "serviceId": "SHO365",
    "enabled": boolean,
    "tenant": {
      "tenantId": string,
      "clientId": string
    }
  },
  "copyShortcut": {
    "serviceId": "STANDARDCOPY",
    "enabled": boolean
  },
  "standardScanShortcut": {
    "serviceId": "STANDARDSCAN",
    "enabled": boolean
  },
  "standardFaxShortcut": {
    "serviceId": "STANDARDFAX",
    "enabled": boolean
  }
},
"authentication-way": {
  "oneTimePasswordEnrollment": boolean,
  "cardOnlyAuthentication": boolean,
  "shortIdAuthentication": boolean,
  "developerLogEnabled": boolean
}

ScanConnectorInfo

CODE

"id": int,
"name": string,					                          // max length 100
"description": string,			                          // optional, max length 300
"connectorType": string,		                          // EMAIL, ONEDRIVE_BUSINESS_OAUTH2, SHAREPOINT_ONLINE_OAUTH2
"sharePointConnectorParameters": {		                  // optional, used only if connectorType is SHAREPOINT_ONLINE_OAUTH2   
  "siteName": string 			                          // optional, will be empty if not specified
},
"retryAttemptsCount": int, 		// optional, default 0, range 0-99999
"retryAttemptsTimeout": int		// optional, number of seconds, default 3, range 0-120
"deliveryRestrictions": {		// optional, may be null
  "enabled": true,				// optional, default false
  "maxScanJobSize": int			// required if enabled is 'true', otherwise not used, maximum scan job size in megabytes, range 1-999999
}

ScanWorkflowTemplateInfo

CODE

"id": int,
"name": string,                 // max length 100
"description": string,          // optional, max length 300
"connectorId": int,
"scanOptions": {                // optional, may be null
  "resolution": string,         // optional, LOW, NORMAL, FINE, HIGH, HIGHEST
  "colorMode": string,          // optional, AUTO, BLACK_AND_WHITE, FULL_COLOR, ONE_COLOR, TWO_COLOR, GRAY_SCALE
  "pageSides": string,          // optional, SIMPLEX, DUPLEX
  "mergingOriginals": string,   // optional, DISABLED, ENABLED
},
"ocrOptions": OcrProcessingStep, // optional, may be null
"smtpConnector": {               // optional, used only if connectorType is EMAIL
  "mailTo": string,
  "mailSubject": string,
  "mailBody": string,
},
"sharePointConnector": {        // optional, used only if connectorType is SHAREPOINT_ONLINE_OAUTH2
  "rootPath": string,
  "relativeTargetPath": string,
  "overwriteBehavior": string,  // KEEP_BOTH, REPLACE_ORIGINAL, APPEND_TO_PDF, PREPEND_TO_PDF
  "columns": list<SharePointColumnsData>,
},
"oneDriveConnector": {          // optional, used only if connectorType is ONEDRIVE_BUSINESS_OAUTH2
  "relativeTargetPath": string,
  "overwriteBehavior": string,  // KEEP_BOTH, REPLACE_ORIGINAL, APPEND_TO_PDF, PREPEND_TO_PDF
},
"fileName": string,             // optional, may be null
"fileType": string,             // PDF, TIFF, JPEG
"sortOrder": string,            // optional, default is last (e.g. 3 if this is 3rd workflow created)
"active": int,
"userInputs": list<UserInputInfo>	// optional, may be null

ScanWorkflowAccessInfo

CODE

"id": int,
"workflowId": string,		// optional, id of ScanWorkflowTemplateInfo
"workflowName": string,		// optional, name of ScanWorkflowTemplateInfo
"identityId": int,		    // optional
"identityName": string		// optional
"identityType": String, 	// optional, User or Group
"allowAccess": boolean		// optional, default true

OcrProcessingStep

CODE

"blankPages": boolean,                // all fields are optional
"dualPages": boolean,
"pageOrientation": boolean,
"despeckle": boolean,
"languages": list<string>,
"outputFormatParameters": {
  "pdfaCompliance": string,           // PDF_A_1A, PDF_A_1B, PDF_A_2A, PDF_A_2U, PDF_A_3A, PDF_A_3U
  "modifyMetadata": boolean,
  "metaTitle": string,
  "metaAuthor": string,
  "metaSubject": string,
  "metaKeywords": string,
  "metaOverwriteUponChange": boolean,
  "mrcCompression": boolean,
  "encryptPdf": boolean,
  "encryptionStrength": string,       // RC40BIT, RC128BIT, AES128BIT
  "encryptionPasswordType": string,   // GeneratePassword, ManualPassword
  "encryptionPassword": string,       // only used when encryptionPasswordType is ManualPassword
  "sendEmail": boolean,
  "emailRecipients": string,
  "emailSubject": string,
  "emailBody": string
}

UserInputInfo

CODE

name: string,
label: string,                        
defaultValue: string,                 // optional, may be null
required: boolean,                    // optional, may be null
userInputType: string,                // LIST BROWSE TEXT NUMBER EMAIL
values: List<ListUserInputValueInfo>  // optional, may be null. Only used for type

ListUserInputValueInfo

CODE

value: string
label: string

SharePointColumnsData

CODE

string: string                       // first string is column name, second is column value