ScannerVision Web Server

<back to all web services

GetScan

Requires Authentication
The following routes are available for this service:
GET/{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 .other suffix or ?format=other

HTTP + OTHER

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

GET /{Brand}/scan HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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