Kofax .NET Restful Web Service API for device client
Kofax .NET Restful Web Service API for device client
Classes
Kofax.KFS.DataModel.WCF._api.Request Namespace Reference

Classes

class  RESTfulCustomIconRequest
 This class is used to retrieve the defined icon of the specified destination/shortcut. More...
 
class  RESTfulDeviceListRequest
 Request message for getting list of devices for sepcified vendors. More...
 
class  RESTfulEndJobRequest
 This class is used to complete/cancel the job requested by the “startjob” web service. More...
 
class  RESTfulGetIndexFieldsRequest
 This class is used to retrieve index fields from the specified destination/shortcut. More...
 
class  RESTfulGetScanSettingsRequest
 This class is used to retrieve scan settings from the specified destination/shortcut. More...
 
class  RESTfulGetShortcutVersionRequest
 This class is used to retrieve the version number of the specified destination/shortcut. More...
 
class  RESTfulLogRequest
 This class is used to send a log message to be logged by server. More...
 
class  RESTfulLookupRequest
 This class is used to perform lookup for an index field such as fax, email, and SharePoint. More...
 
class  RESTfulMetricsRequest
 Request for getting specified system metric (summary) information defined in Kofax.KFS.DataModel.Common.Process.MetricType. This request requires authentication. More...
 
class  RESTfulRegisterRequest
 This class is used to register the client to the Kofax product. More...
 
class  RESTfulRequest
 This is generic web service request that includes client locale. More...
 
class  RESTfulSendImagesByPartRequest
 This 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. More...
 
class  RESTfulSendImagesRequest
 This class is used to send an image from the client to the Kofax product and releases it to the destination. More...
 
class  RESTfulShortcutNamesRequest
 Request message for getting list all shortcut names available on the server. More...
 
class  RESTfulStartJobRequest
 This class is used to start a job request. More...
 
class  RESTfulSubmitRequest
 Inherits RESTfulGetIndexFieldsRequest and specifies information about the request, including the document note, image, imageType and jobId are combined to indicate the submission status. More...
 
class  RESTfulUpdateDeviceInfoRequest
 This class is used to attempt to update metadata associated with the client identified by the client ID. More...
 
class  RESTfulUserLoginRequest
 This class is used to login the KFS system with specified user name and password. More...
 
class  RESTfulValidateFieldRequest
 This class is used to request an updated list of field values based on the current values in the form. More...
 
class  RESTfulValidateFormRequest
 This class is used to identify any fields with errors. More...
 
class  RESTfulValidateUserNameRequest
 This class is used to query the Kofax product to determine if the submitted user name is valid. More...