| POST | /{Brand}/scan |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Brand | form | Brand | No |
| Desktop | |
| Hp | |
| Kyocera | |
| NeaScan | |
| Samsung | |
| FujiXerox | |
| Ta | |
| Utax | |
| Epson | |
| ScanFront400 | |
| Sharp | |
| Ricoh | |
| FujiFilm |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DoGetImage | form | bool | No | |
| TemplateGuid | form | string | No | |
| FileNameGuid | form | string | No | |
| ServerUrlRoot | form | string | No | |
| TemplateIcon | form | byte[] | No | |
| TemplateName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SelectedUiLanguage | form | string | No | |
| svSession | form | string | No | |
| Title | form | string | No | |
| PageTip | form | string | No | |
| NewBrowser | form | bool | No | |
| ScanFront400TA | form | bool | No | |
| ScanFront400UTAX | form | bool | No |
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
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"}