ScannerVision Web Server

<back to all web services

GetScan

Requires Authentication
The following routes are available for this service:
GET/{Brand}/scan
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetScan extends RequestBase
    {
        
    }

    public static class RequestBase extends DtoBase
    {
        
    }

    public static class DtoBase
    {
        public Brand Brand = null;
        
        public Brand getBrand() { return Brand; }
        public DtoBase setBrand(Brand value) { this.Brand = value; return this; }
    }

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

    public static class GetScanResponse extends ResponseBase
    {
        public Boolean DoGetImage = null;
        public String TemplateGuid = null;
        public String FileNameGuid = null;
        public String ServerUrlRoot = null;
        public byte[] TemplateIcon = null;
        public String TemplateName = null;
        
        public Boolean isDoGetImage() { return DoGetImage; }
        public GetScanResponse setDoGetImage(Boolean value) { this.DoGetImage = value; return this; }
        public String getTemplateGuid() { return TemplateGuid; }
        public GetScanResponse setTemplateGuid(String value) { this.TemplateGuid = value; return this; }
        public String getFileNameGuid() { return FileNameGuid; }
        public GetScanResponse setFileNameGuid(String value) { this.FileNameGuid = value; return this; }
        public String getServerUrlRoot() { return ServerUrlRoot; }
        public GetScanResponse setServerUrlRoot(String value) { this.ServerUrlRoot = value; return this; }
        public byte[] getTemplateIcon() { return TemplateIcon; }
        public GetScanResponse setTemplateIcon(byte[] value) { this.TemplateIcon = value; return this; }
        public String getTemplateName() { return TemplateName; }
        public GetScanResponse setTemplateName(String value) { this.TemplateName = value; return this; }
    }

    public static class ResponseBase extends DtoBase
    {
        public String SelectedUiLanguage = null;
        public String svSession = null;
        public String Title = null;
        public String PageTip = null;
        public Boolean NewBrowser = null;
        public Boolean ScanFront400TA = null;
        public Boolean ScanFront400UTAX = null;
        
        public String getSelectedUiLanguage() { return SelectedUiLanguage; }
        public ResponseBase setSelectedUiLanguage(String value) { this.SelectedUiLanguage = value; return this; }
        public String getSvSession() { return svSession; }
        public ResponseBase setSvSession(String value) { this.svSession = value; return this; }
        public String getTitle() { return Title; }
        public ResponseBase setTitle(String value) { this.Title = value; return this; }
        public String getPageTip() { return PageTip; }
        public ResponseBase setPageTip(String value) { this.PageTip = value; return this; }
        public Boolean isNewBrowser() { return NewBrowser; }
        public ResponseBase setNewBrowser(Boolean value) { this.NewBrowser = value; return this; }
        public Boolean isScanFront400TA() { return ScanFront400TA; }
        public ResponseBase setScanFront400TA(Boolean value) { this.ScanFront400TA = value; return this; }
        public Boolean isScanFront400UTAX() { return ScanFront400UTAX; }
        public ResponseBase setScanFront400UTAX(Boolean value) { this.ScanFront400UTAX = value; return this; }
    }

}

Java GetScan 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.

GET /{Brand}/scan HTTP/1.1 
Host: buildmax.org 
Accept: application/json
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"}