Kofax .NET Restful Web Service API for Device Client
All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12345]
 CKofax.KFS.Services.Contracts._api.IRESTfulServiceDefines RESTful web services
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulDeviceListRequestRequest message for getting list of devices for sepcified vendors.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulDeviceListResponseResponse message containing list of devices found for the specified vendors.
 CKofax.KFS.DataModel.WCF._api.RESTfulIndexFieldAttributes for the field.
 CKofax.KFS.DataModel.WCF._api.RESTfulJobHistoryLogItemContains history information about a single job.
 CKofax.KFS.DataModel.WCF._api.RESTfulMetricDeviceDevice information
 CKofax.KFS.DataModel.WCF._api.RESTfulMetricInputRequested information for Metric input
 CKofax.KFS.DataModel.WCF._api.RESTfulMetricOutputMetric output information
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulMetricsRequestRequest for getting specified system metric (summary) information defined in Kofax.KFS.DataModel.Common.Process.MetricType. This request requires authentication.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulMetricsResponseResponse message containing information for the requested metric-types.
 CKofax.KFS.DataModel.WCF._api.RESTfulMetricStatusMetric status information
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulRequestThis is generic web service request that includes client locale.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulGetIndexFieldsRequestThis class is used to retrieve index fields from the specified destination/shortcut.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulCustomIconRequestThis class is used to retrieve the defined icon of the specified destination/shortcut.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulEndJobRequestThis class is used to complete/cancel the job requested by the “startjob” web service.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulGetScanSettingsRequestThis class is used to retrieve scan settings from the specified destination/shortcut.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulGetShortcutVersionRequestThis class is used to retrieve the version number of the specified destination/shortcut.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulLookupRequestThis class is used to perform lookup for an index field such as fax, email, and SharePoint.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulStartJobRequestThis class is used to start a job request.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulSubmitRequestInherits RESTfulGetIndexFieldsRequest and specifies information about the request, including the document note, image, imageType and jobId are combined to indicate the submission status.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulSendImagesRequestThis class is used to send an image from the client to the Kofax product and releases it to the destination.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulSendImagesByPartRequestThis 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.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulValidateFieldRequestThis class is used to request an updated list of field values based on the current values in the form.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulValidateFormRequestThis class is used to identify any fields with errors.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulLogRequestThis class is used to send a log message to be logged by server.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulUpdateDeviceInfoRequestThis class is used to attempt to update metadata associated with the client identified by the client ID.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulRegisterRequestThis class is used to register the client to the Kofax product.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulUserLoginRequestThis class is used to login the KFS system with specified user name and password.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulValidateUserNameRequestThis class is used to query the Kofax product to determine if the submitted user name is valid.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulResponseThis 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.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulCustomIconResponseThis is a Web service response that includes and image object in Base64 string.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetGlobalShortcutsResponseThis is a Web service response that includes the global shortcuts information.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetIndexFieldsResponseThis is a Web service response that includes the array of index fields
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulValidateFieldResponseThis is a Web service response that includes a flag to indicate whether the client should replace all infex fields or not.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetJobHistoryLogsResponseThis is a Web service response that includes the array of job histories.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetJobStatusResponseThis is a Web service response that includes the current status of the job.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetPersonalShortcutsResponseThis is a Web service response that includes the array of shortcut/destination.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetScanSettingsResponseThis is a Web service response that includes the scan settings information.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetShortcutResponseThis is a Web service response that includes the array of index fields, scan settings, version etc.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulGetShortcutVersionResponseThis is a Web service response that includes the latest version of the specified destination/shortcut.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulLicenseCheckResponseThis is a Web service response that indicates the client is licensed or not.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulLogResponseThis is a Web service response that inherits the generic web service response class.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulLookupResponseThis is a Web service response that includes the array of the search results.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulStartJobResponseThis is a Web service response that includes the job ID when the job has started.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulUserLoginResponseThis is a Web service response that includes the user login informations.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulValidateFormResponseThis 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.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulValidateUserNameResponseThis 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.
 CKofax.KFS.DataModel.WCF._api.RESTfulScanSettingDefines a single scan setting value, that contains the name and value attributes.
 CKofax.KFS.DataModel.WCF._api.RESTfulScanSettingsStores a list of scan setting items.
 CKofax.KFS.DataModel.WCF._api.RESTfulSearchListEntryThis is used for Lookup data.
 CKofax.KFS.DataModel.WCF._api.RESTfulShortcutDestinationThis is used for Shortcut/destination data.
 CKofax.KFS.DataModel.WCF._api.Request.RESTfulShortcutNamesRequestRequest message for getting list all shortcut names available on the server.
 CKofax.KFS.DataModel.WCF._api.Response.RESTfulShortcutNamesResponseResponse message containing list of all shortcut names on the server.
 CKofax.KFS.DataModel.WCF._api.RESTfulStatusTypeItemThis is used for Job status data.
 CKofax.KFS.DataModel.WCF._api.RESTfulSuggestedValueThis is used for the suggested value data.