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 net.servicestack.client.*


open class GetScanSBC : RequestBase()
{
}

open class RequestBase : DtoBase()
{
}

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

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

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

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

Kotlin GetScanSBC DTOs

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

HTTP + CSV

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: buildmax.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{Unable to show example output for type 'GetScanResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.