ScannerVision Web Server

GetJsonTemplateRequest

import Foundation
import ServiceStack

public class GetJsonTemplateRequest : JsonDto
{
    public var guid:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case guid
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        guid = try container.decodeIfPresent(String.self, forKey: .guid)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if guid != nil { try container.encode(guid, forKey: .guid) }
    }
}

public class JsonDto : Codable
{
    required public init(){}
}

public class GetJsonTemplateResponse : JsonDto
{
    public var template:JsonTemplate

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case template
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        template = try container.decodeIfPresent(JsonTemplate.self, forKey: .template)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if template != nil { try container.encode(template, forKey: .template) }
    }
}

public class JsonTemplate : Codable
{
    public var name:String
    public var Description:String
    public var guid:String
    public var templateModificationDate:Date
    public var iconModificationDate:Date
    public var icon:[UInt8] = []
    public var templateQuestions:[JsonQuestion] = []
    public var globalQuestions:[JsonQuestion] = []
    public var scanSettings:JsonScanSettings

    required public init(){}
}

public class JsonQuestion : Codable
{
    public var plQuestionType:QuestionType
    public var question:String
    public var tagName:String
    public var `default`:String
    public var toolTip:String
    public var sampleValue:String
    public var regex:String
    public var minimum:Int
    public var maximum:Int
    public var required:Bool
    public var dynamic:Bool
    public var picklistGuid:String
    public var templateGuid:String
    public var hideDefaultValue:Bool

    required public init(){}
}

public enum QuestionType : String, Codable
{
    case Edit
    case List
    case EditList
    case Browse
    case Password
    case Date
    case Time
    case Boolean
    case Integer
    case Double
    case BrowseList
}

public class JsonScanSettings : Codable
{
    public var scanType:String
    public var scanTypeLocked:Bool
    public var scanColour:String
    public var scanColourLocked:Bool
    public var scanResolution:String
    public var scanResolutionLocked:Bool
    public var scanSide:String
    public var scanSideLocked:Bool
    public var scanSize:String
    public var scanSizeLocked:Bool
    public var scanOrientation:String
    public var scanOrientationLocked:Bool
    public var scanSource:String
    public var scanSourceLocked:Bool
    public var scanContinuously:Bool
    public var scanContinuouslyLocked:Bool
    public var isMixedSizes:Bool
    public var isMixedSizesLocked:Bool
    public var minimumPageCount:Int
    public var maximumPageCount:Int

    required public init(){}
}

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