ScannerVision Web Server

GetJsonTemplateRequest


export class JsonDto
{

    public constructor(init?: Partial<JsonDto>) { (Object as any).assign(this, init); }
}

export class GetJsonTemplateRequest extends JsonDto
{
    public Guid: string;

    public constructor(init?: Partial<GetJsonTemplateRequest>) { super(init); (Object as any).assign(this, init); }
}

export class JsonScanSettings
{
    public ScanType: string;
    public ScanTypeLocked: boolean;
    public ScanColour: string;
    public ScanColourLocked: boolean;
    public ScanResolution: string;
    public ScanResolutionLocked: boolean;
    public ScanSide: string;
    public ScanSideLocked: boolean;
    public ScanSize: string;
    public ScanSizeLocked: boolean;
    public ScanOrientation: string;
    public ScanOrientationLocked: boolean;
    public ScanSource: string;
    public ScanSourceLocked: boolean;
    public ScanContinuously: boolean;
    public ScanContinuouslyLocked: boolean;
    public IsMixedSizes: boolean;
    public IsMixedSizesLocked: boolean;
    public MinimumPageCount: number;
    public MaximumPageCount: number;

    public constructor(init?: Partial<JsonScanSettings>) { (Object as any).assign(this, init); }
}

export class JsonTemplate
{
    public Name: string;
    public Description: string;
    public Guid: string;
    public TemplateModificationDate: string;
    public IconModificationDate: string;
    public Icon: string;
    public TemplateQuestions: JsonQuestion[];
    public GlobalQuestions: JsonQuestion[];
    public ScanSettings: JsonScanSettings;

    public constructor(init?: Partial<JsonTemplate>) { (Object as any).assign(this, init); }
}

export class GetJsonTemplateResponse extends JsonDto
{
    public Template: JsonTemplate;

    public constructor(init?: Partial<GetJsonTemplateResponse>) { super(init); (Object as any).assign(this, init); }
}

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

export class JsonQuestion
{
    public PlQuestionType: QuestionType;
    public Question: string;
    public TagName: string;
    public Default: string;
    public ToolTip: string;
    public SampleValue: string;
    public Regex: string;
    public Minimum: number;
    public Maximum: number;
    public Required: boolean;
    public Dynamic: boolean;
    public PicklistGuid: string;
    public TemplateGuid: string;
    public HideDefaultValue: boolean;

    public constructor(init?: Partial<JsonQuestion>) { (Object as any).assign(this, init); }
}

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