ScannerVision Web Server

GetJsonTemplateRequest

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


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

open class JsonDto
{
}

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

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

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

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

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

Kotlin GetJsonTemplateRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/GetJsonTemplateRequest HTTP/1.1 
Host: dmsshow.kyocerasolutions.cz 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Guid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Template: 
	{
		Name: String,
		Description: String,
		Guid: String,
		TemplateModificationDate: 0001-01-01,
		IconModificationDate: 0001-01-01,
		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
		}
	}
}