ScannerVision Web Server

<back to all web services

GetScanSBC

Requires Authentication
The following routes are available for this service:
POST/{Brand}/scan
DtoBase Parameters:
NameParameterData TypeRequiredDescription
BrandformBrandNo
Brand Enum:
Desktop
Hp
Kyocera
NeaScan
Samsung
FujiXerox
Ta
Utax
Epson
ScanFront400
Sharp
Ricoh
FujiFilm
GetScanResponse Parameters:
NameParameterData TypeRequiredDescription
DoGetImageformboolNo
TemplateGuidformstringNo
FileNameGuidformstringNo
ServerUrlRootformstringNo
TemplateIconformbyte[]No
TemplateNameformstringNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
SelectedUiLanguageformstringNo
svSessionformstringNo
TitleformstringNo
PageTipformstringNo
NewBrowserformboolNo
ScanFront400TAformboolNo
ScanFront400UTAXformboolNo

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}/scan HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Brand":"Desktop"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}