ScannerVision Web Server

<back to all web services

GetScanSBC

Requires Authentication
The following routes are available for this service:
POST/{Brand}/scan
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetScanSBC : RequestBase()
{
}

open class RequestBase : DtoBase()
{
}

open class DtoBase
{
    open var Brand:Brand? = null
}

enum class Brand
{
    Desktop,
    Hp,
    Kyocera,
    NeaScan,
    Samsung,
    FujiXerox,
    Ta,
    Utax,
    Epson,
    ScanFront400,
    Sharp,
    Ricoh,
    FujiFilm,
    Brother,
}

open class GetScanResponse : ResponseBase()
{
    open var DoGetImage:Boolean? = null
    open var TemplateGuid:String? = null
    open var FileNameGuid:String? = null
    open var ServerUrlRoot:String? = null
    open var TemplateIcon:ByteArray? = null
    open var TemplateName:String? = null
}

open class ResponseBase : DtoBase()
{
    open var SelectedUiLanguage:String? = null
    open var svSession:String? = null
    open var Title:String? = null
    open var PageTip:String? = null
    open var NewBrowser:Boolean? = null
    open var ScanFront400TA:Boolean? = null
    open var ScanFront400UTAX:Boolean? = null
}

Kotlin GetScanSBC DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Brand}/scan HTTP/1.1 
Host: dmsshow.kyocerasolutions.cz 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Brand: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DoGetImage: False,
	TemplateGuid: String,
	FileNameGuid: String,
	ServerUrlRoot: String,
	TemplateIcon: AA==,
	TemplateName: String,
	SelectedUiLanguage: String,
	svSession: String,
	Title: String,
	PageTip: String,
	NewBrowser: False,
	ScanFront400TA: False,
	ScanFront400UTAX: False,
	Brand: Desktop
}