▼NKofax | |
▼NKFS | |
▼NServices | |
▼NContracts | |
▼NLegacy | |
▼NWebServices | |
▶NDevice | |
CDeviceServicePortType | Attempts to update metadata associated with the device identified by the wscClientID parameter. |
CDeviceServicePortTypeChannel | Attempts to update metadata associated with the device identified by the wscClientID parameter. |
CDeviceServicePortTypeClient | Attempts to update metadata associated with the device identified by the wscClientID parameter. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
▶NDocTracking | |
CDocTrackingServicePortType | Service for sending document tracking events to the server. |
CDocTrackingServicePortTypeChannel | Channel for sending document tracking to server. |
CDocTrackingServicePortTypeClient | Client for sending document tracking to server. |
CWscDocTrackingRequest | Request for writing a document tracking event at the server side. Unused in KFS 4.x and later versions. Kept for backward-compatibility purposes. |
CWscDocTrackingResponse | This is a Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
▶NGetAdvancedSettings | |
CgetAdvancedSettingsRequest | Request message for getting advanced setting from server. |
CgetAdvancedSettingsResponse | Response message for a request to get advanced setting from server. |
CGetAdvancedSettingsServicePortType | Legacy service for getting an advanced setting from the server such as getting retry's interval/duration... |
CGetAdvancedSettingsServicePortTypeChannel | Client for getting advanced setting from server. |
CGetAdvancedSettingsServicePortTypeClient | Client for sending request to get advanced settings from server. |
CWscGetAdvancedSettingsRequest | |
CWscGetAdvancedSettingsResponse | |
▶NGetFieldsToValidate | |
CgetFieldsToValidateRequest | Extends wscRequest with information for the fields to be validated. |
CgetFieldsToValidateResponse | Returns information about the fields |
CGetFieldsToValidateServicePortType | Sent from the client to request fields to perform validation. The server retrieves a list of fields, which indicates the fields that trigger validation, what the value of the field is, whether the field is read-only, and if the field is a selection list (and whether or not it forces matches). This service should be invoked when the user the indexing is first loaded and when the user starts a new job. |
CGetFieldsToValidateServicePortTypeChannel | Channel for validating index fields at the server. |
CGetFieldsToValidateServicePortTypeClient | Sent from the client to request fields to perform validation. The server retrieves a list of fields, which indicates the fields that trigger validation, what the value of the field is, whether the field is read-only, and if the field is a selection list (and whether or not it forces matches). This service should be invoked when the user the indexing is first loaded and when the user starts a new job. |
CWscGetFieldsToValidateRequest | Extends WscRequest and includes parameters for different fields. |
CWscGetFieldsToValidateResponse | Returns information about the fields. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscValidationFieldInfo | Includes parameters for the fields. |
▶NGetIndexFields | |
CgetIndexFieldsRequest | Retrieves index fields from the specified destination. |
CgetIndexFieldsResponse | Generates a response that includes the array of index fields. |
CGetIndexFieldsServicePortType | Retrieves index fields from the specified destination. |
CGetIndexFieldsServicePortTypeChannel | Retrieves index fields from the specified destination. |
CGetIndexFieldsServicePortTypeClient | Retrieves index fields from the specified destination. |
CWscIndexField | Attributes for the field. |
CWscIndexFieldsRequest | Retrieves information about the index field. |
CWscIndexFieldsResponse | This is a Web service response that includes the array of index fields, result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscRequest | This generic web service request is used by all Web services. Important Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
▶NGetIndexFields2 | |
CgetIndexFields2Request | Retrieves index fields from the specified destination. |
CgetIndexFields2Response | Generates a response that includes the array of index fields. |
CGetIndexFieldsService2PortType | Retrieves index fields from the specified destination. |
CGetIndexFieldsService2PortTypeChannel | Retrieves index fields from the specified destination. |
CGetIndexFieldsService2PortTypeClient | Retrieves index fields from the specified destination. |
CWscIndexField | Attributes for the field. |
CWscIndexField2 | Array of index fields. |
CWscIndexFieldsRequest | Retrieves information about the index field. |
CWscIndexFieldsResponse2 | This is a Web service response that includes the array of index fields, result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscRequest | This generic web service request is used by all Web services. Important Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
▶NLicenseCheck | |
CLicenseCheckServicePortType | Queries the Kofax product to determine if the Web Services Connector client is licensed. |
CLicenseCheckServicePortTypeChannel | Queries the Kofax product to determine if the Web Services Connector client is licensed. |
CLicenseCheckServicePortTypeClient | Queries the Kofax product to determine if the Web Services Connector client is licensed. |
CWscLicenseCheckResponse | Gets the status of the license for the Web Services client. |
▶NLookup | |
ClookupRequest | Performs the lookup request. |
ClookupResponse | Retrieves the lookup response. |
CLookupServicePortType | Performs fax and email lookup for an index field. See the Kofax product's Guide for instructions for configuring the lookup. |
CLookupServicePortTypeChannel | Performs fax or email lookup for an index field. See the Kofax product's Guide for instructions for configuring the lookup. |
CLookupServicePortTypeClient | Performs fax or email lookup for an index field. See the Kofax product's Guide for instructions for configuring the lookup. |
CWscLookupRequest | Sends the request to perform the lookup. |
CWscLookupResponse | Response to the lookup, which include an array of search results, result code, and error message, if any. |
CWscRequest | This generic web service request is used by all Web services. Important Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscSearchListEntry | An array of search results. |
▶NMetrics | |
CgetDeviceListRequest | Request message for getting list of devices for sepcified vendors. |
CgetDeviceListResponse | Response message containing list of devices found for the specified vendors. |
CgetMetricsRequest | Request for getting specified system metric (summary) information defined in Kofax.KFS.DataModel.Common.Process.MetricType. This request requires authentication. |
CgetMetricsResponse | Response message containing information for the requested metric-types. |
CgetShortcutNamesRequest | Request message for getting list all shortcut names available on the server. |
CgetShortcutNamesResponse | Response message containing list of all shortcut names on the server. |
CMetricDevice | |
CMetricDeviceResponse | |
CMetricInput | |
CMetricOutput | |
CMetricOutputResponse | |
CMetricShortcutResponse | |
CMetricsServicePortType | Legacy service for getting system metric information, device list and shortcut names from server. |
CMetricsServicePortTypeChannel | Channel for invoking the Metric Service. |
CMetricsServicePortTypeClient | Client for invoking the Metric service. |
CMetricStatus | |
▶NNotification | |
CNotification | Array of notifications to be sent. Each notification is contained in a Notification object. The fields in the Notification object are specified with a NotificationField object. The fields defined with NotificationField objects are TO, CC, BCC, SUBJECT, and BODY. |
CNotificationField | Fields for the notification. |
CNotificationRequest | A request that sends the API key and the notification text. |
CNotificationResponse | Contains resultCode and errorMessage, if any. |
CNotificationServicePortType | Sends notifications by email of events that occur with a document. Refer to the Kofax product Help for instructions. |
CNotificationServicePortTypeChannel | Channel interface for Notification service. |
CNotificationServicePortTypeClient | Client for sending notification to server. |
CsendNotificationRequest | Request messag for sending notifications by email of events that occur with a document. |
CsendNotificationResponse | Response message for a request to send notifications from a legacy mfp device. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
▶NPing | |
CException | Exception wrapper class for sending error information back to legacy client. |
CPingServicePortType | Submits a ping request to the Kofax product to validate connection to the server is active. |
CPingServicePortTypeChannel | Submits a ping request to the Kofax product to validate connection to the server is active. |
CPingServicePortTypeClient | Submits a ping request to the Kofax product to validate connection to the server is active. |
CXMLStreamException | Error class for any xml stream exception. Reserved. Not used. |
▶NProfile | |
CgetProfileRequest | Sends the current profile ID and timestamp and retrieves the new profile information, if the profile has changed. |
CgetProfileResponse | Retreives the response for the profile operation. |
CProfileServicePortType | Retrieves the current profile associated with the specified Web Services Connector client ID. The profile is a list of the global shortcuts where the Web Services Connector client can submit documents. Each global shortcut contains information about a destination, including index fields. This service is intended to be used to poll the Kofax product for new profile information. The previously obtained profile ID and profile timestamps are passed in, and the server returns new information if the profile has changed. |
CProfileServicePortTypeChannel | Retrieves the current profile associated with the specified Web Services Connector client ID. The profile is a list of the global shortcuts where the Web Services Connector client can submit documents. Each global shortcut contains information about a destination, including index fields. This service is intended to be used to poll the Kofax product for new profile information. The previously obtained profile ID and profile timestamps are passed in, and the server returns new information if the profile has changed. |
CProfileServicePortTypeClient | Retrieves the current profile associated with the specified Web Services Connector client ID. The profile is a list of the global shortcuts where the Web Services Connector client can submit documents. Each global shortcut contains information about a destination, including index fields. This service is intended to be used to poll the Kofax product for new profile information. The previously obtained profile ID and profile timestamps are passed in, and the server returns new information if the profile has changed. |
CWscDestination | Attributes for a destination. |
CWscIndexField | Attributes for the field. |
CWscProfileRequest | Sends the profile request with the client ID. May include the profile ID and a timestamp. Submitting any currentProfileId string or currentProfileTimestamp that does not match the profile ID or timestamp associated with the client at the server will result in the current profile associated with the client at the server being returned in the WscProfileResponse, without any error. The purpose of submitting the current profile ID and timestamp at the client is simply to avoid the processing delay of looking up the profile information at the server, if the profile has not changed since the last profile received by the client. When the current profile ID and current profile timestamp from the client match the server values, the profile has not changed at the server. |
CWscProfileResponse | Gets the response, which includes the new profile ID and timestamp, global shortcuts that are part of the profile, result code, and error message, if any. |
▶NRetrieveAllUsers | |
CgetAllUsers2Request | Request message for getting a specified number of users in the system. |
CgetAllUsers2Response | Response message for a request to get a specified number of users from a legacy MFP Client. |
CgetAllUsersRequest | Retrieves list of user names. |
CgetAllUsersResponse | Response message for a request to get all users from a legacy mfp device. |
CRetrieveAllUsersServicePortType | Retrieves the list of users from the specified server. If there is a large number of the Kofax product users (greater than 1,000), use ValidateUserService instead to check if a user exists. |
CRetrieveAllUsersServicePortTypeChannel | Retrieves the list of users from the specified server. If there is a large number of the Kofax product users (greater than 1,000), use ValidateUserService instead to check if a user exists. |
CRetrieveAllUsersServicePortTypeClient | Retrieves the list of users from the specified server. If there is a large number of the Kofax product users (greater than 1,000), use ValidateUserService instead to check if a user exists. |
CWscRetrieveAllUsersResponse | Returns a result code, an error message if result code is not 0, and an array of user names. |
▶NRetrieveScanSettings | |
CgetScanSettingsRequest | Legacy service's request message for getting button's scan settings |
CgetScanSettingsResponse | Response message containing button's scan settings. |
CRetrieveScanSettingsServicePortType | Legacy service for getting button's scan settings. |
CRetrieveScanSettingsServicePortTypeChannel | |
CRetrieveScanSettingsServicePortTypeClient | Retrieves scan settings for a button (shortcut/destination) from server. |
CWscRequest | |
CWscRetrieveScanSettingsRequest | |
CWscRetrieveScanSettingsResponse | |
CWscScanSetting | |
▶NScanActivityPostAction | |
CScanActivityPostActionPortType | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CScanActivityPostActionPortTypeClient | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CScanActivityPostActionPortTypePortTypeChannel | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
▶NScanHistory | |
CgetScanHistoryRequest | Wraps a history request. |
CgetScanHistoryResponse | Wraps a history response. |
CgetStatusTypeRequest | Wraps a status type request. |
CgetStatusTypeResponse | Wraps a status type response. |
CLogItem | Contains history information about a single job. |
CScanHistoryServicePortType | This service exposes various operations for scan history. It can retrieve the history for a specified device or user and the state of previously submitted jobs. The service displays these states using localized names. |
CStatusTypeItem | Key value pair matching a status name to its localized string for the requested language. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponseBase | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscScanHistoryRequest | Enables the caller to specify parameters for retrieving job history. |
CWscScanHistoryResponse | Contains a list of log items for each job history item found. |
CWscStatusRequest | Contains the device ID and language to use for retrieving localized strings. |
CWscStatusResponse | Contains a list of StatusTypeItems for each of the possible job history states. |
▶NSendImage | |
CsendImageRequest | Inherits WscSubmitRequest and includes destination information. |
CsendImageResponse | Inherits WscResponse. |
CSendImageServicePortType | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CSendImageServicePortTypeChannel | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CSendImageServicePortTypeClient | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CWscDestination | Attributes for a destination. |
CWscIndexField | Attributes for the field. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendImageRequest | Inherits WscSubmitRequest and specifies destination information that is encapsulated in WscDestination. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NSendImage2 | |
CsendImageRequest | Inherits WscSubmitRequest and includes destination information. |
CsendImageResponse | Inherits WscResponse. |
CSendImageService2PortType | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CSendImageService2PortTypeChannel | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CSendImageService2PortTypeClient | Sends an image from the Web Services Connector client to the Kofax product and releases it to the destination. Note that this service does not support batch sending. When multiple images are to be sent, you need to send them one by one and indicate the image sequence using the part number and done flag defined in the WscSubmitRequest object. |
CWscDestination | Attributes for a destination. |
CWscIndexField | Attributes for the field. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendImageRequest | Inherits WscSubmitRequest and specifies destination information that is encapsulated in WscDestination. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NSendToKDEInbox | |
CsendToInboxRequest | Sends the image to the specified the Kofax product user and returns the code. |
CsendToInboxResponse | This is a Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CSendToKDEInboxServicePortType | Submits an image to the specified the Kofax product user. |
CSendToKDEInboxServicePortTypeChannel | Submits an image to the specified the Kofax product user. |
CSendToKDEInboxServicePortTypeClient | Submits an image to the specified the Kofax product user. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendToKDEInboxRequest | Inherits WscSubmitRequest and includes the Kofax product user name. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NSendToKDEInbox2 | |
CsendToInboxRequest | Sends the image to the specified the Kofax product user and returns the code. |
CsendToInboxResponse | This is a Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CSendToKDEInboxService2PortType | Submits an image to the specified the Kofax product user. |
CSendToKDEInboxService2PortTypeChannel | Submits an image to the specified the Kofax product user. |
CSendToKDEInboxService2PortTypeClient | Submits an image to the specified the Kofax product user. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendToKDEInboxRequest | Inherits WscSubmitRequest and includes the Kofax product user name. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NSendWithCoversheet | |
CSendWithCoversheetServicePortType | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CSendWithCoversheetServicePortTypeChannel | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CSendWithCoversheetServicePortTypeClient | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CsubmitRequestRequest | Sends the image with coversheet. |
CsubmitRequestResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendWithCoversheetRequest | Inherits WscSubmitRequest and uses the same members. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NSendWithCoversheet2 | |
CSendWithCoversheetService2PortType | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CSendWithCoversheetService2PortTypeChannel | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CSendWithCoversheetService2PortTypeClient | Sends a document with a coversheet. The coversheet image must be the first image sent. |
CsubmitRequestRequest | Sends the image with coversheet. |
CsubmitRequestResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscKeyValuePair | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
CWscSendWithCoversheetRequest | Inherits WscSubmitRequest and uses the same members. |
CWscSubmitRequest | Inherits WscRequest and specifies information about the request, including the whether the document submission was finished successfully, canceled, or aborted. Also includes the type of Web Services Connector client, image type, and part number. In the Kofax product, images are sent one by one if a document submission has multiple images. The partNumber, done, cancelled, and aborted fields are combined to indicate the submission status. |
▶NStartJob | |
CstartJobRequest | Wrap style for the start job request. |
CstartJobResponse | Wrap style for the start job response. |
CStartJobServicePortType | Legacy service for create a new job at server. |
CStartJobServicePortTypeChannel | Channel for invoking StartJob service. |
CStartJobServicePortTypeClient | Client for invoking StartJob service. |
CWscRequest | |
CWscStartJobResponse | |
▶NUserLogin | |
Clogin2Request | Submits log on request. |
Clogin2Response | Retrieves a response to indicate whether or not the logon was successful. |
CloginRequest | Submits log on request. |
CloginResponse | Retrieves a response to indicate whether or not the logon was successful. |
CUserLoginServicePortType | Submits the user name and password. If the user has logged on successfully, the user's personal shortcuts are retrieved. |
CUserLoginServicePortTypeChannel | Submits the user name and password. If the user has logged on successfully, the user's personal shortcuts are retrieved. |
CUserLoginServicePortTypeClient | Submits the user name and password. If the user has logged on successfully, the user's personal shortcuts are retrieved. |
CWscDestination | |
CWscIndexField | Array of index fields for the destination. |
CWscUserLoginResponse | Retrieves a Boolean value to indicate whether or not the logon was successful. If the logon is successful, it retrieves the user's personal shortcuts. The response also retrieves a result code, and error message, if there is one. |
▶NUserLogout | |
CUserLogoutServicePortType | Logs off the user from the Web Services Connector client. |
CUserLogoutServicePortTypeChannel | Logs off the user from the Web Services Connector client. |
CUserLogoutServicePortTypeClient | Logs off the user from the Web Services Connector client. |
CWscUserLogoutResponse | Returns a result code to indicate whether or not the logout was successful and an error message, if an error occured. |
▶NValidateField | |
CvalidateFieldRequest | Extends WscRequest and includes information about the field to be validated. |
CvalidateFieldResponse | Returns information about the fields. |
CValidateFieldServicePortType | Sent by the client to request an updated list of field values based on the current values in the form. The server returns the value of the field, whether the field is read-only, if the field is a selection list (and whether or not it forces matches), and if the entry in the field is valid. This service should be invoked when the user exits a field after entering or changing a value. |
CValidateFieldServicePortTypeChannel | Sent by the client to request an updated list of field values based on the current values in the form. The server returns the value of the field, whether the field is read-only, if the field is a selection list (and whether or not it forces matches), and if the entry in the field is valid. This service should be invoked when the user exits a field after entering or changing a value. |
CValidateFieldServicePortTypeClient | Sent by the client to request an updated list of field values based on the current values in the form. The server returns the value of the field, whether the field is read-only, if the field is a selection list (and whether or not it forces matches), and if the entry in the field is valid. This service should be invoked when the user exits a field after entering or changing a value. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscValidateFieldRequest | Extends WscRequest and includes information about the field. |
CWscValidateFieldResponse | Returns information about the fields. |
CWscValidationFieldInfo | Includes parameters for the fields. |
▶NValidateForm | |
CvalidateFormRequest | Extends WscRequest and includes information about the form. |
CvalidateFormResponse | Returns information about the form. |
CValidateFormServicePortType | Sent by the client to the server to identify any fields with errors. The server returns a list of fields that includes the value of the fields and if they are valid. An error message is provided with invalid values. This service should be invoked when the user finishes indexing and submits the form. |
CValidateFormServicePortTypeChannel | Sent by the client to the server to identify any fields with errors. The server returns a list of fields that includes the value of the fields and if they are valid. An error message is provided with invalid values. This service should be invoked when the user finishes indexing and submits the form. |
CValidateFormServicePortTypeClient | Sent by the client to the server to identify any fields with errors. The server returns a list of fields that includes the value of the fields and if they are valid. An error message is provided with invalid values. This service should be invoked when the user finishes indexing and submits the form. |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscValidateFormRequest | Extends WscRequest and includes information about the form. |
CWscValidateFormResponse | Returns information about the fields. |
CWscValidationFieldInfo | Includes parameters for the fields. |
▶NValidateUser | |
CValidateUserServicePortType | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CValidateUserServicePortTypeChannel | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CValidateUserServicePortTypeClient | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CWscValidateUserNameResponse | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
▶NValidateUser2 | |
CValidateUserService2PortType | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CValidateUserService2PortTypeChannel | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CValidateUserService2PortTypeClient | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CWscValidateUserNameResponse | If the submitted user name (case-insensitive) is valid, this will return the user name with the correct capitalization. |
CIWscResponse | |
CIWscVersioningResponse | |
CWscRequest | This generic web service request is used by all Web services. Every job submitted to the Kofax product must have a unique job ID that is different from any job ID used by any other Web Services Connector client or input device (such as MFPs and scanners). Always include the Web Services Connector client ID in the job ID string. This will ensure that your client's job IDs are always different than another Web Services Connector client's or device's job IDs. Also include a unique counter or timestamp in milliseconds in the job ID string to ensure that subsequent job IDs from the same Web Services Connector client are unique. |
CWscResponse | This is a generic Web service response that includes the result code, an error message, and a flag to indicate whether the client should retry to recover from an error. The result code is an integer value that is set to 0 for a successful Web service call. Any other value indicates a failure. If an error occurs, the error message property is set. |
▼NWebServices | |
▼NGetDeviceDestinations | |
CDeviceDestinationsServicePortTypeChannel | Channel interface for DeviceDestination service. |
CDeviceDestinationsServicePortTypeClient | The client for invoking DeviceDestination service. |
CgetDeviceDestinationsRequest | Request message for getting destinations which can be used in a legacy mfp device for the current logged-on user, if any. |
CgetDeviceDestinationsResponse | Response message for a request to get destinations which can be used in a legacy mfp device for the current logged-on user, if any. |
CGetDeviceDestinationsServicePortType | Legacy service for getting destinations (buttons) available on the target device for current-logged-on user, if any. |
CWscDestination2 | Attributes for a destination. |
CWscDeviceDestinationsRequest | |
CWscDeviceDestinationsResponse | Response message for a request to get destinations to be displayed from a legacy MFP Client. |
▼NGetDynamicFieldsAndValidate | |
CgetDynamicFieldsAndValidateRequest | Legacy MFP Client's request message for validating value of a dynamic index field. |
CgetDynamicFieldsAndValidateResponse | Response message for a request to validate value of a dynamic index field from a legacy MFP Client. |
CGetDynamicFieldsAndValidateServicePortType | Defines service type for Legacy MFP Clients to call and validate value of a dynamic index field. |
CGetDynamicFieldsAndValidateServicePortTypeChannel | Channel interface for Validate Dynamic field service. |
CGetDynamicFieldsAndValidateServicePortTypeClient | The client for invoking Validate Dynamic field service. |
CWscDynamicFieldsAndValidateRequest | Legacy MFP Client's request message for validating value of a dynamic index field. |
CWscDynamicFieldsAndValidateResponse | Response message for a request to validate value of a dynamic index field from a legacy MFP Client. |
CWscIndexFieldDynamic | Defines index field data structure for legacy MFP devices. |
CWscSuggested | Represents a suggested index field value used for displaying combobox or choice list at a legacy MFP client. |