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