ScannerVision Web Server

GetJsonTemplateRequest

**GetJsonTemplateRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Guid	query	string	No

**GetJsonTemplateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Template	form	JsonTemplate	No

**JsonTemplate** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
Guid	form	string	No
TemplateModificationDate	form	DateTime	No
IconModificationDate	form	DateTime	No
Icon	form	byte[]	No
TemplateQuestions	form	JsonQuestion[]	No
GlobalQuestions	form	JsonQuestion[]	No
ScanSettings	form	JsonScanSettings	No

**JsonQuestion** Parameters:
Name	Parameter	Data Type	Required
PlQuestionType	form	QuestionType	No
Question	form	string	No
TagName	form	string	No
Default	form	string	No
ToolTip	form	string	No
SampleValue	form	string	No
Regex	form	string	No
Minimum	form	int	No
Maximum	form	int	No
Required	form	bool	No
Dynamic	form	bool	No
PicklistGuid	form	string	No
TemplateGuid	form	string	No
HideDefaultValue	form	bool	No

**QuestionType** Enum:
Edit
List
EditList
Browse
Password
Date
Time
Boolean
Integer
Double
BrowseList

**JsonScanSettings** Parameters:
Name	Parameter	Data Type	Required
ScanType	form	string	No
ScanTypeLocked	form	bool	No
ScanColour	form	string	No
ScanColourLocked	form	bool	No
ScanResolution	form	string	No
ScanResolutionLocked	form	bool	No
ScanSide	form	string	No
ScanSideLocked	form	bool	No
ScanSize	form	string	No
ScanSizeLocked	form	bool	No
ScanOrientation	form	string	No
ScanOrientationLocked	form	bool	No
ScanSource	form	string	No
ScanSourceLocked	form	bool	No
ScanContinuously	form	bool	No
ScanContinuouslyLocked	form	bool	No
IsMixedSizes	form	bool	No
IsMixedSizesLocked	form	bool	No
MinimumPageCount	form	int	No
MaximumPageCount	form	int	No

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