ScannerVision Web Server

<back to all web services

GetJsonTemplateRequest

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetJsonTemplateRequest extends JsonDto
    {
        public String Guid = null;
        
        public String getGuid() { return Guid; }
        public GetJsonTemplateRequest setGuid(String value) { this.Guid = value; return this; }
    }

    public static class JsonDto
    {
        
    }

    public static class GetJsonTemplateResponse extends JsonDto
    {
        public JsonTemplate Template = null;
        
        public JsonTemplate getTemplate() { return Template; }
        public GetJsonTemplateResponse setTemplate(JsonTemplate value) { this.Template = value; return this; }
    }

    public static class JsonTemplate
    {
        public String Name = null;
        public String Description = null;
        public String Guid = null;
        public Date TemplateModificationDate = null;
        public Date IconModificationDate = null;
        public byte[] Icon = null;
        public ArrayList<JsonQuestion> TemplateQuestions = null;
        public ArrayList<JsonQuestion> GlobalQuestions = null;
        public JsonScanSettings ScanSettings = null;
        
        public String getName() { return Name; }
        public JsonTemplate setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public JsonTemplate setDescription(String value) { this.Description = value; return this; }
        public String getGuid() { return Guid; }
        public JsonTemplate setGuid(String value) { this.Guid = value; return this; }
        public Date getTemplateModificationDate() { return TemplateModificationDate; }
        public JsonTemplate setTemplateModificationDate(Date value) { this.TemplateModificationDate = value; return this; }
        public Date getIconModificationDate() { return IconModificationDate; }
        public JsonTemplate setIconModificationDate(Date value) { this.IconModificationDate = value; return this; }
        public byte[] getIcon() { return Icon; }
        public JsonTemplate setIcon(byte[] value) { this.Icon = value; return this; }
        public ArrayList<JsonQuestion> getTemplateQuestions() { return TemplateQuestions; }
        public JsonTemplate setTemplateQuestions(ArrayList<JsonQuestion> value) { this.TemplateQuestions = value; return this; }
        public ArrayList<JsonQuestion> getGlobalQuestions() { return GlobalQuestions; }
        public JsonTemplate setGlobalQuestions(ArrayList<JsonQuestion> value) { this.GlobalQuestions = value; return this; }
        public JsonScanSettings getScanSettings() { return ScanSettings; }
        public JsonTemplate setScanSettings(JsonScanSettings value) { this.ScanSettings = value; return this; }
    }

    public static class JsonQuestion
    {
        public QuestionType PlQuestionType = null;
        public String Question = null;
        public String TagName = null;
        public String Default = null;
        public String ToolTip = null;
        public String SampleValue = null;
        public String Regex = null;
        public Integer Minimum = null;
        public Integer Maximum = null;
        public Boolean Required = null;
        public Boolean Dynamic = null;
        public String PicklistGuid = null;
        public String TemplateGuid = null;
        public Boolean HideDefaultValue = null;
        
        public QuestionType getPlQuestionType() { return PlQuestionType; }
        public JsonQuestion setPlQuestionType(QuestionType value) { this.PlQuestionType = value; return this; }
        public String getQuestion() { return Question; }
        public JsonQuestion setQuestion(String value) { this.Question = value; return this; }
        public String getTagName() { return TagName; }
        public JsonQuestion setTagName(String value) { this.TagName = value; return this; }
        public String getDefault() { return Default; }
        public JsonQuestion setDefault(String value) { this.Default = value; return this; }
        public String getToolTip() { return ToolTip; }
        public JsonQuestion setToolTip(String value) { this.ToolTip = value; return this; }
        public String getSampleValue() { return SampleValue; }
        public JsonQuestion setSampleValue(String value) { this.SampleValue = value; return this; }
        public String getRegex() { return Regex; }
        public JsonQuestion setRegex(String value) { this.Regex = value; return this; }
        public Integer getMinimum() { return Minimum; }
        public JsonQuestion setMinimum(Integer value) { this.Minimum = value; return this; }
        public Integer getMaximum() { return Maximum; }
        public JsonQuestion setMaximum(Integer value) { this.Maximum = value; return this; }
        public Boolean isRequired() { return Required; }
        public JsonQuestion setRequired(Boolean value) { this.Required = value; return this; }
        public Boolean isDynamic() { return Dynamic; }
        public JsonQuestion setDynamic(Boolean value) { this.Dynamic = value; return this; }
        public String getPicklistGuid() { return PicklistGuid; }
        public JsonQuestion setPicklistGuid(String value) { this.PicklistGuid = value; return this; }
        public String getTemplateGuid() { return TemplateGuid; }
        public JsonQuestion setTemplateGuid(String value) { this.TemplateGuid = value; return this; }
        public Boolean isHideDefaultValue() { return HideDefaultValue; }
        public JsonQuestion setHideDefaultValue(Boolean value) { this.HideDefaultValue = value; return this; }
    }

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

    public static class JsonScanSettings
    {
        public String ScanType = null;
        public Boolean ScanTypeLocked = null;
        public String ScanColour = null;
        public Boolean ScanColourLocked = null;
        public String ScanResolution = null;
        public Boolean ScanResolutionLocked = null;
        public String ScanSide = null;
        public Boolean ScanSideLocked = null;
        public String ScanSize = null;
        public Boolean ScanSizeLocked = null;
        public String ScanOrientation = null;
        public Boolean ScanOrientationLocked = null;
        public String ScanSource = null;
        public Boolean ScanSourceLocked = null;
        public Boolean ScanContinuously = null;
        public Boolean ScanContinuouslyLocked = null;
        public Boolean IsMixedSizes = null;
        public Boolean IsMixedSizesLocked = null;
        public Integer MinimumPageCount = null;
        public Integer MaximumPageCount = null;
        
        public String getScanType() { return ScanType; }
        public JsonScanSettings setScanType(String value) { this.ScanType = value; return this; }
        public Boolean isScanTypeLocked() { return ScanTypeLocked; }
        public JsonScanSettings setScanTypeLocked(Boolean value) { this.ScanTypeLocked = value; return this; }
        public String getScanColour() { return ScanColour; }
        public JsonScanSettings setScanColour(String value) { this.ScanColour = value; return this; }
        public Boolean isScanColourLocked() { return ScanColourLocked; }
        public JsonScanSettings setScanColourLocked(Boolean value) { this.ScanColourLocked = value; return this; }
        public String getScanResolution() { return ScanResolution; }
        public JsonScanSettings setScanResolution(String value) { this.ScanResolution = value; return this; }
        public Boolean isScanResolutionLocked() { return ScanResolutionLocked; }
        public JsonScanSettings setScanResolutionLocked(Boolean value) { this.ScanResolutionLocked = value; return this; }
        public String getScanSide() { return ScanSide; }
        public JsonScanSettings setScanSide(String value) { this.ScanSide = value; return this; }
        public Boolean isScanSideLocked() { return ScanSideLocked; }
        public JsonScanSettings setScanSideLocked(Boolean value) { this.ScanSideLocked = value; return this; }
        public String getScanSize() { return ScanSize; }
        public JsonScanSettings setScanSize(String value) { this.ScanSize = value; return this; }
        public Boolean isScanSizeLocked() { return ScanSizeLocked; }
        public JsonScanSettings setScanSizeLocked(Boolean value) { this.ScanSizeLocked = value; return this; }
        public String getScanOrientation() { return ScanOrientation; }
        public JsonScanSettings setScanOrientation(String value) { this.ScanOrientation = value; return this; }
        public Boolean isScanOrientationLocked() { return ScanOrientationLocked; }
        public JsonScanSettings setScanOrientationLocked(Boolean value) { this.ScanOrientationLocked = value; return this; }
        public String getScanSource() { return ScanSource; }
        public JsonScanSettings setScanSource(String value) { this.ScanSource = value; return this; }
        public Boolean isScanSourceLocked() { return ScanSourceLocked; }
        public JsonScanSettings setScanSourceLocked(Boolean value) { this.ScanSourceLocked = value; return this; }
        public Boolean isScanContinuously() { return ScanContinuously; }
        public JsonScanSettings setScanContinuously(Boolean value) { this.ScanContinuously = value; return this; }
        public Boolean isScanContinuouslyLocked() { return ScanContinuouslyLocked; }
        public JsonScanSettings setScanContinuouslyLocked(Boolean value) { this.ScanContinuouslyLocked = value; return this; }
        public Boolean getIsMixedSizes() { return IsMixedSizes; }
        public JsonScanSettings setIsMixedSizes(Boolean value) { this.IsMixedSizes = value; return this; }
        public Boolean getIsMixedSizesLocked() { return IsMixedSizesLocked; }
        public JsonScanSettings setIsMixedSizesLocked(Boolean value) { this.IsMixedSizesLocked = value; return this; }
        public Integer getMinimumPageCount() { return MinimumPageCount; }
        public JsonScanSettings setMinimumPageCount(Integer value) { this.MinimumPageCount = value; return this; }
        public Integer getMaximumPageCount() { return MaximumPageCount; }
        public JsonScanSettings setMaximumPageCount(Integer value) { this.MaximumPageCount = value; return this; }
    }

}

Java GetJsonTemplateRequest 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.

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

{"Guid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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