ScannerVision Web Server

<back to all web services

GetJsonTemplateRequest

Requires Authentication
GetJsonTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
GuidquerystringNo
GetJsonTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
TemplateformJsonTemplateNo
JsonTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
GuidformstringNo
TemplateModificationDateformDateTimeNo
IconModificationDateformDateTimeNo
Iconformbyte[]No
TemplateQuestionsformJsonQuestion[]No
GlobalQuestionsformJsonQuestion[]No
ScanSettingsformJsonScanSettingsNo
JsonQuestion Parameters:
NameParameterData TypeRequiredDescription
PlQuestionTypeformQuestionTypeNo
QuestionformstringNo
TagNameformstringNo
DefaultformstringNo
ToolTipformstringNo
SampleValueformstringNo
RegexformstringNo
MinimumformintNo
MaximumformintNo
RequiredformboolNo
DynamicformboolNo
PicklistGuidformstringNo
TemplateGuidformstringNo
HideDefaultValueformboolNo
QuestionType Enum:
Edit
List
EditList
Browse
Password
Date
Time
Boolean
Integer
Double
BrowseList
JsonScanSettings Parameters:
NameParameterData TypeRequiredDescription
ScanTypeformstringNo
ScanTypeLockedformboolNo
ScanColourformstringNo
ScanColourLockedformboolNo
ScanResolutionformstringNo
ScanResolutionLockedformboolNo
ScanSideformstringNo
ScanSideLockedformboolNo
ScanSizeformstringNo
ScanSizeLockedformboolNo
ScanOrientationformstringNo
ScanOrientationLockedformboolNo
ScanSourceformstringNo
ScanSourceLockedformboolNo
ScanContinuouslyformboolNo
ScanContinuouslyLockedformboolNo
IsMixedSizesformboolNo
IsMixedSizesLockedformboolNo
MinimumPageCountformintNo
MaximumPageCountformintNo

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