ScannerVision Web Server

<back to all web services

UploadRequest

Requires Authentication
The following routes are available for this service:
All Verbs/{Brand}/upload/{TemplateGuid}/{FileNameGuid}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UploadRequest : RequestBase()
{
    var TemplateGuid:String? = null
    var FileNameGuid:String? = null
}

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 UploadResponse : ResponseBase()
{
    var InError:Boolean? = null
    var ErrorMessage:String? = null
    var TemplateGuid: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 UploadRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Brand}/upload/{TemplateGuid}/{FileNameGuid} HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TemplateGuid":"String","FileNameGuid":"String","Brand":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"InError":false,"ErrorMessage":"String","TemplateGuid":"String","SelectedUiLanguage":"String","svSession":"String","Title":"String","PageTip":"String","NewBrowser":false,"ScanFront400TA":false,"ScanFront400UTAX":false,"Brand":"Desktop"}