ScannerVision Web Server

<back to all web services

GetScan

Requires Authentication
The following routes are available for this service:
GET/{Brand}/scan
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ScannerVision.WebService.ServiceModel;

namespace ScannerVision.WebService.ServiceModel
{
    public enum Brand
    {
        Desktop,
        Hp,
        Kyocera,
        NeaScan,
        Samsung,
        FujiXerox,
        Ta,
        Utax,
        Epson,
        ScanFront400,
        Sharp,
        Ricoh,
        FujiFilm,
    }

    public partial class DtoBase
    {
        public virtual Brand Brand { get; set; }
    }

    public partial class GetScan
        : RequestBase
    {
    }

    public partial class GetScanResponse
        : ResponseBase
    {
        public GetScanResponse()
        {
            TemplateIcon = new byte[]{};
        }

        public virtual bool DoGetImage { get; set; }
        public virtual string TemplateGuid { get; set; }
        public virtual string FileNameGuid { get; set; }
        public virtual string ServerUrlRoot { get; set; }
        public virtual byte[] TemplateIcon { get; set; }
        public virtual string TemplateName { get; set; }
    }

    public partial class RequestBase
        : DtoBase
    {
    }

    public partial class ResponseBase
        : DtoBase
    {
        public virtual string SelectedUiLanguage { get; set; }
        public virtual string svSession { get; set; }
        public virtual string Title { get; set; }
        public virtual string PageTip { get; set; }
        public virtual bool NewBrowser { get; set; }
        public virtual bool ScanFront400TA { get; set; }
        public virtual bool ScanFront400UTAX { get; set; }
    }

}

C# 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"}