ScannerVision Web Server

GetJsonTemplateRequest

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetJsonTemplateRequest : JsonDto()
{
    var Guid:String? = null
}

open class JsonDto
{
}

open class GetJsonTemplateResponse : JsonDto()
{
    var Template:JsonTemplate? = null
}

open class JsonTemplate
{
    var Name:String? = null
    var Description:String? = null
    var Guid:String? = null
    var TemplateModificationDate:Date? = null
    var IconModificationDate:Date? = null
    var Icon:ByteArray? = null
    var TemplateQuestions:ArrayList<JsonQuestion>? = null
    var GlobalQuestions:ArrayList<JsonQuestion>? = null
    var ScanSettings:JsonScanSettings? = null
}

open class JsonQuestion
{
    var PlQuestionType:QuestionType? = null
    var Question:String? = null
    var TagName:String? = null
    var Default:String? = null
    var ToolTip:String? = null
    var SampleValue:String? = null
    var Regex:String? = null
    var Minimum:Int? = null
    var Maximum:Int? = null
    var Required:Boolean? = null
    var Dynamic:Boolean? = null
    var PicklistGuid:String? = null
    var TemplateGuid:String? = null
    var HideDefaultValue:Boolean? = null
}

enum class QuestionType
{
    Edit,
    List,
    EditList,
    Browse,
    Password,
    Date,
    Time,
    Boolean,
    Integer,
    Double,
    BrowseList,
}

open class JsonScanSettings
{
    var ScanType:String? = null
    var ScanTypeLocked:Boolean? = null
    var ScanColour:String? = null
    var ScanColourLocked:Boolean? = null
    var ScanResolution:String? = null
    var ScanResolutionLocked:Boolean? = null
    var ScanSide:String? = null
    var ScanSideLocked:Boolean? = null
    var ScanSize:String? = null
    var ScanSizeLocked:Boolean? = null
    var ScanOrientation:String? = null
    var ScanOrientationLocked:Boolean? = null
    var ScanSource:String? = null
    var ScanSourceLocked:Boolean? = null
    var ScanContinuously:Boolean? = null
    var ScanContinuouslyLocked:Boolean? = null
    var IsMixedSizes:Boolean? = null
    var IsMixedSizesLocked:Boolean? = null
    var MinimumPageCount:Int? = null
    var MaximumPageCount:Int? = null
}

Kotlin 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}}}