ScannerVision Web Server

GetJsonTemplateRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ScannerVision.WebService.Json.Dto

Namespace Global

    Namespace ScannerVision.WebService.Json.Dto

        Public Partial Class GetJsonTemplateRequest
            Inherits JsonDto
            Public Overridable Property Guid As String
        End Class

        Public Partial Class GetJsonTemplateResponse
            Inherits JsonDto
            Public Overridable Property Template As JsonTemplate
        End Class

        Public Partial Class JsonDto
        End Class

        Public Partial Class JsonQuestion
            Public Overridable Property PlQuestionType As QuestionType
            Public Overridable Property Question As String
            Public Overridable Property TagName As String
            Public Overridable Property [Default] As String
            Public Overridable Property ToolTip As String
            Public Overridable Property SampleValue As String
            Public Overridable Property Regex As String
            Public Overridable Property Minimum As Integer
            Public Overridable Property Maximum As Integer
            Public Overridable Property Required As Boolean
            Public Overridable Property Dynamic As Boolean
            Public Overridable Property PicklistGuid As String
            Public Overridable Property TemplateGuid As String
            Public Overridable Property HideDefaultValue As Boolean

            Public Enum QuestionType
                Edit
                List
                EditList
                Browse
                Password
                [Date]
                Time
                Boolean
                [Integer]
                [Double]
                BrowseList
            End Enum
        End Class

        Public Partial Class JsonScanSettings
            Public Overridable Property ScanType As String
            Public Overridable Property ScanTypeLocked As Boolean
            Public Overridable Property ScanColour As String
            Public Overridable Property ScanColourLocked As Boolean
            Public Overridable Property ScanResolution As String
            Public Overridable Property ScanResolutionLocked As Boolean
            Public Overridable Property ScanSide As String
            Public Overridable Property ScanSideLocked As Boolean
            Public Overridable Property ScanSize As String
            Public Overridable Property ScanSizeLocked As Boolean
            Public Overridable Property ScanOrientation As String
            Public Overridable Property ScanOrientationLocked As Boolean
            Public Overridable Property ScanSource As String
            Public Overridable Property ScanSourceLocked As Boolean
            Public Overridable Property ScanContinuously As Boolean
            Public Overridable Property ScanContinuouslyLocked As Boolean
            Public Overridable Property IsMixedSizes As Boolean
            Public Overridable Property IsMixedSizesLocked As Boolean
            Public Overridable Property MinimumPageCount As Integer
            Public Overridable Property MaximumPageCount As Integer
        End Class

        Public Partial Class JsonTemplate
            Public Sub New()
                Icon = New Byte(){}
                TemplateQuestions = New JsonQuestion(){}
                GlobalQuestions = New JsonQuestion(){}
            End Sub

            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Guid As String
            Public Overridable Property TemplateModificationDate As Date
            Public Overridable Property IconModificationDate As Date
            Public Overridable Property Icon As Byte()
            Public Overridable Property TemplateQuestions As JsonQuestion()
            Public Overridable Property GlobalQuestions As JsonQuestion()
            Public Overridable Property ScanSettings As JsonScanSettings
        End Class
    End Namespace
End Namespace

VB.NET GetJsonTemplateRequest 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.

POST /json/reply/GetJsonTemplateRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Guid":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Template":{"Name":"String","Description":"String","Guid":"String","TemplateModificationDate":"\/Date(-62135596800000-0000)\/","IconModificationDate":"\/Date(-62135596800000-0000)\/","Icon":"AA==","TemplateQuestions":[{"PlQuestionType":"Edit","Question":"String","TagName":"String","Default":"String","ToolTip":"String","SampleValue":"String","Regex":"String","Minimum":0,"Maximum":0,"Required":false,"Dynamic":false,"PicklistGuid":"String","TemplateGuid":"String","HideDefaultValue":false}],"GlobalQuestions":[{"PlQuestionType":"Edit","Question":"String","TagName":"String","Default":"String","ToolTip":"String","SampleValue":"String","Regex":"String","Minimum":0,"Maximum":0,"Required":false,"Dynamic":false,"PicklistGuid":"String","TemplateGuid":"String","HideDefaultValue":false}],"ScanSettings":{"ScanType":"String","ScanTypeLocked":false,"ScanColour":"String","ScanColourLocked":false,"ScanResolution":"String","ScanResolutionLocked":false,"ScanSide":"String","ScanSideLocked":false,"ScanSize":"String","ScanSizeLocked":false,"ScanOrientation":"String","ScanOrientationLocked":false,"ScanSource":"String","ScanSourceLocked":false,"ScanContinuously":false,"ScanContinuouslyLocked":false,"IsMixedSizes":false,"IsMixedSizesLocked":false,"MinimumPageCount":0,"MaximumPageCount":0}}}