Kofax .NET Restful Web Service API for Device Client
All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1234567]
 NKofax
 NKFS
 NDataModel
 NWCF
 N_api
 NRequest
 CRESTfulCustomIconRequestThis class is used to retrieve the defined icon of the specified destination/shortcut.
 CRESTfulDeviceListRequestRequest message for getting list of devices for sepcified vendors.
 CRESTfulEndJobRequestThis class is used to complete/cancel the job requested by the “startjob” web service.
 CRESTfulGetIndexFieldsRequestThis class is used to retrieve index fields from the specified destination/shortcut.
 CRESTfulGetScanSettingsRequestThis class is used to retrieve scan settings from the specified destination/shortcut.
 CRESTfulGetShortcutVersionRequestThis class is used to retrieve the version number of the specified destination/shortcut.
 CRESTfulLogRequestThis class is used to send a log message to be logged by server.
 CRESTfulLookupRequestThis class is used to perform lookup for an index field such as fax, email, and SharePoint.
 CRESTfulMetricsRequestRequest for getting specified system metric (summary) information defined in Kofax.KFS.DataModel.Common.Process.MetricType. This request requires authentication.
 CRESTfulRegisterRequestThis class is used to register the client to the Kofax product.
 CRESTfulRequestThis is generic web service request that includes client locale.
 CRESTfulSendImagesByPartRequestThis class is used to send a part of an image from the client to the Kofax product, and then all parts of the image are combined at server side and the image is released to the destination.
 CRESTfulSendImagesRequestThis class is used to send an image from the client to the Kofax product and releases it to the destination.
 CRESTfulShortcutNamesRequestRequest message for getting list all shortcut names available on the server.
 CRESTfulStartJobRequestThis class is used to start a job request.
 CRESTfulSubmitRequestInherits RESTfulGetIndexFieldsRequest and specifies information about the request, including the document note, image, imageType and jobId are combined to indicate the submission status.
 CRESTfulUpdateDeviceInfoRequestThis class is used to attempt to update metadata associated with the client identified by the client ID.
 CRESTfulUserLoginRequestThis class is used to login the KFS system with specified user name and password.
 CRESTfulValidateFieldRequestThis class is used to request an updated list of field values based on the current values in the form.
 CRESTfulValidateFormRequestThis class is used to identify any fields with errors.
 CRESTfulValidateUserNameRequestThis class is used to query the Kofax product to determine if the submitted user name is valid.
 NResponse
 CRESTfulCustomIconResponseThis is a Web service response that includes and image object in Base64 string.
 CRESTfulDeviceListResponseResponse message containing list of devices found for the specified vendors.
 CRESTfulGetGlobalShortcutsResponseThis is a Web service response that includes the global shortcuts information.
 CRESTfulGetIndexFieldsResponseThis is a Web service response that includes the array of index fields
 CRESTfulGetJobHistoryLogsResponseThis is a Web service response that includes the array of job histories.
 CRESTfulGetJobStatusResponseThis is a Web service response that includes the current status of the job.
 CRESTfulGetPersonalShortcutsResponseThis is a Web service response that includes the array of shortcut/destination.
 CRESTfulGetScanSettingsResponseThis is a Web service response that includes the scan settings information.
 CRESTfulGetShortcutResponseThis is a Web service response that includes the array of index fields, scan settings, version etc.
 CRESTfulGetShortcutVersionResponseThis is a Web service response that includes the latest version of the specified destination/shortcut.
 CRESTfulLicenseCheckResponseThis is a Web service response that indicates the client is licensed or not.
 CRESTfulLogResponseThis is a Web service response that inherits the generic web service response class.
 CRESTfulLookupResponseThis is a Web service response that includes the array of the search results.
 CRESTfulMetricsResponseResponse message containing information for the requested metric-types.
 CRESTfulResponseThis is a generic Web service response that includes the error code, and error message, and a flaf to indicate whether the client should retry to recover from an error. the error 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.
 CRESTfulShortcutNamesResponseResponse message containing list of all shortcut names on the server.
 CRESTfulStartJobResponseThis is a Web service response that includes the job ID when the job has started.
 CRESTfulUserLoginResponseThis is a Web service response that includes the user login informations.
 CRESTfulValidateFieldResponseThis is a Web service response that includes a flag to indicate whether the client should replace all infex fields or not.
 CRESTfulValidateFormResponseThis is a Web service response that includes the array of index fields and a flag to indicate whether these index fields are valid or not.
 CRESTfulValidateUserNameResponseThis is a Web service response that includes user name with the correct capitalization and a flag to indicate whether the user name is valid or not.
 CRESTfulIndexFieldAttributes for the field.
 CRESTfulJobHistoryLogItemContains history information about a single job.
 CRESTfulMetricDeviceDevice information
 CRESTfulMetricInputRequested information for Metric input
 CRESTfulMetricOutputMetric output information
 CRESTfulMetricStatusMetric status information
 CRESTfulScanSettingDefines a single scan setting value, that contains the name and value attributes.
 CRESTfulScanSettingsStores a list of scan setting items.
 CRESTfulSearchListEntryThis is used for Lookup data.
 CRESTfulShortcutDestinationThis is used for Shortcut/destination data.
 CRESTfulStatusTypeItemThis is used for Job status data.
 CRESTfulSuggestedValueThis is used for the suggested value data.
 NServices
 NContracts
 N_api
 CIRESTfulServiceDefines RESTful web services