ScannerVision Web Server

<back to all web services

GetScan

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

Namespace Global

    Namespace ScannerVision.WebService.ServiceModel

        Public Enum Brand
            Desktop
            Hp
            Kyocera
            NeaScan
            Samsung
            FujiXerox
            Ta
            Utax
            Epson
            ScanFront400
            Sharp
            Ricoh
            FujiFilm
        End Enum

        Public Partial Class DtoBase
            Public Overridable Property Brand As Brand
        End Class

        Public Partial Class GetScan
            Inherits RequestBase
        End Class

        Public Partial Class GetScanResponse
            Inherits ResponseBase
            Public Sub New()
                TemplateIcon = New Byte(){}
            End Sub

            Public Overridable Property DoGetImage As Boolean
            Public Overridable Property TemplateGuid As String
            Public Overridable Property FileNameGuid As String
            Public Overridable Property ServerUrlRoot As String
            Public Overridable Property TemplateIcon As Byte()
            Public Overridable Property TemplateName As String
        End Class

        Public Partial Class RequestBase
            Inherits DtoBase
        End Class

        Public Partial Class ResponseBase
            Inherits DtoBase
            Public Overridable Property SelectedUiLanguage As String
            Public Overridable Property svSession As String
            Public Overridable Property Title As String
            Public Overridable Property PageTip As String
            Public Overridable Property NewBrowser As Boolean
            Public Overridable Property ScanFront400TA As Boolean
            Public Overridable Property ScanFront400UTAX As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetScan DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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