ScannerVision Web Server

<back to all web services

GetJsonTemplateRequest

Requires Authentication
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ScannerVision.WebService.Json.Dto;

namespace ScannerVision.WebService.Json.Dto
{
    public partial class GetJsonTemplateRequest
        : JsonDto
    {
        public virtual string Guid { get; set; }
    }

    public partial class GetJsonTemplateResponse
        : JsonDto
    {
        public virtual JsonTemplate Template { get; set; }
    }

    public partial class JsonDto
    {
    }

    public partial class JsonQuestion
    {
        public virtual QuestionType PlQuestionType { get; set; }
        public virtual string Question { get; set; }
        public virtual string TagName { get; set; }
        public virtual string Default { get; set; }
        public virtual string ToolTip { get; set; }
        public virtual string SampleValue { get; set; }
        public virtual string Regex { get; set; }
        public virtual int Minimum { get; set; }
        public virtual int Maximum { get; set; }
        public virtual bool Required { get; set; }
        public virtual bool Dynamic { get; set; }
        public virtual string PicklistGuid { get; set; }
        public virtual string TemplateGuid { get; set; }
        public virtual bool HideDefaultValue { get; set; }
        public enum QuestionType
        {
            Edit,
            List,
            EditList,
            Browse,
            Password,
            Date,
            Time,
            Boolean,
            Integer,
            Double,
            BrowseList,
        }

    }

    public partial class JsonScanSettings
    {
        public virtual string ScanType { get; set; }
        public virtual bool ScanTypeLocked { get; set; }
        public virtual string ScanColour { get; set; }
        public virtual bool ScanColourLocked { get; set; }
        public virtual string ScanResolution { get; set; }
        public virtual bool ScanResolutionLocked { get; set; }
        public virtual string ScanSide { get; set; }
        public virtual bool ScanSideLocked { get; set; }
        public virtual string ScanSize { get; set; }
        public virtual bool ScanSizeLocked { get; set; }
        public virtual string ScanOrientation { get; set; }
        public virtual bool ScanOrientationLocked { get; set; }
        public virtual string ScanSource { get; set; }
        public virtual bool ScanSourceLocked { get; set; }
        public virtual bool ScanContinuously { get; set; }
        public virtual bool ScanContinuouslyLocked { get; set; }
        public virtual bool IsMixedSizes { get; set; }
        public virtual bool IsMixedSizesLocked { get; set; }
        public virtual int MinimumPageCount { get; set; }
        public virtual int MaximumPageCount { get; set; }
    }

    public partial class JsonTemplate
    {
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string Guid { get; set; }
        public virtual DateTime TemplateModificationDate { get; set; }
        public virtual DateTime IconModificationDate { get; set; }
        public virtual byte[] Icon { get; set; }
        public virtual JsonQuestion[] TemplateQuestions { get; set; }
        public virtual JsonQuestion[] GlobalQuestions { get; set; }
        public virtual JsonScanSettings ScanSettings { get; set; }
    }

}

C# 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
		}
	}
}