ScannerVision Web Server

ScanSettingsRequest

The following routes are available for this service:
POST	/{Brand}/scansettings/{TemplateGuid}

**ScanSettingsRequest** Parameters:
Name	Parameter	Data Type	Required
TemplateGuid	path	string	No
SelectedColour	body	ScanColour	No
SelectedOrientation	body	ScanOrientation	No
SelectedResolution	body	ScanResolution	No
SelectedSides	body	ScanSide	No
SelectedSize	body	ScanSize	No
SelectedSource	body	ScanSource	No
SelectedType	body	ScanType	No
SelectedScanContinuously	body	BoolSetting	No
SelectedMixedSizes	body	BoolSetting	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required	Description
Brand	form	Brand	No

**Brand** Enum:
Desktop
Hp
Kyocera
NeaScan
Samsung
FujiXerox
Ta
Utax
Epson
ScanFront400
Sharp
Ricoh
FujiFilm

**ScanColour** Enum:
BlackAndWhite	IDS_SETTINGS_CAPT3_COLORS_0
Greyscale	IDS_SETTINGS_CAPT3_COLORS_1
Colour	IDS_SETTINGS_CAPT3_COLORS_2
Auto	IDS_SETTINGS_CAPT3_COLORS_3

**ScanOrientation** Enum:
Portrait	IDS_SETTINGS_CAPT3_ORIENTATION_0
Landscape	IDS_SETTINGS_CAPT3_ORIENTATION_1

**ScanResolution** Enum:
Dpi100	100
Dpi200	200
Dpi300	300
Dpi400	400
Dpi600	600

**ScanSide** Enum:
Simplex	IDS_SETTINGS_CAPT3_SIDES_0
Duplex	IDS_SETTINGS_CAPT3_SIDES_1

**ScanSize** Enum:
Auto	IDS_SETTINGS_CAPT3_SIZE_0
A3	IDS_SETTINGS_CAPT3_SIZE_1
A4	IDS_SETTINGS_CAPT3_SIZE_2
A5	IDS_SETTINGS_CAPT3_SIZE_3
B4	IDS_SETTINGS_CAPT3_SIZE_4
B5	IDS_SETTINGS_CAPT3_SIZE_5
Letter	IDS_SETTINGS_CAPT3_SIZE_6
Legal	IDS_SETTINGS_CAPT3_SIZE_7
Executive	IDS_SETTINGS_CAPT3_SIZE_8
Folio	IDS_SETTINGS_CAPT3_SIZE_9
AutoLong	IDS_SETTINGS_CAPT3_SIZE_10
A4R	IDS_SETTINGS_CAPT3_SIZE_11
A5R	IDS_SETTINGS_CAPT3_SIZE_12
A6R	IDS_SETTINGS_CAPT3_SIZE_13
B6R	IDS_SETTINGS_CAPT3_SIZE_14

**ScanSource** Enum:
Adf	IDS_SETTINGS_CAPT3_SCAN_SOURCE_0
Glass	IDS_SETTINGS_CAPT3_SCAN_SOURCE_1
Auto	IDS_SETTINGS_CAPT3_SCAN_SOURCE_2

**ScanType** Enum:
Text	IDS_SETTINGS_CAPT3_TYPE_0
Photo	IDS_SETTINGS_CAPT3_TYPE_1
TextAndPhoto	IDS_SETTINGS_CAPT3_TYPE_2

**BoolSetting** Enum:
True
False

**GetTemplateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ServerAddress	form	string	No
ServerPort	form	int	No

**ScanResponseBase** Parameters:
Name	Parameter	Data Type	Required
Template	form	IClientTemplate	No
GlobalQuestions	form	IEnumerable<IClientQuestion>	No
CanEnableScanButton	form	bool	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required
SelectedUiLanguage	form	string	No
svSession	form	string	No
Title	form	string	No
PageTip	form	string	No
NewBrowser	form	bool	No
ScanFront400TA	form	bool	No
ScanFront400UTAX	form	bool	No

**IClientTemplate** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
Icon	form	byte[]	No
ModificationInfo	form	ITemplateModificationInfo	No
Name	form	string	No
Questions	form	IEnumerable<IClientQuestion>	No
Template	form	ITemplate	No
TemplateGuid	form	string	No

**ITemplateModificationInfo** Parameters:
Name	Parameter	Data Type	Required
Guid	form	string	No
TemplateModificationDateTime	form	DateTime	No
IconModificationDateTime	form	DateTime	No

**IClientQuestion** Parameters:
Name	Parameter	Data Type	Required
QuestionGuid	form	string	No
ValueDisplayed	form	string	No
ValueReturned	form	string	No
Answered	form	bool	No
RegexMatches	form	bool	No
RegexHint	form	string	No

**ITemplate** Parameters:
Name	Parameter	Data Type	Required
TemplateVersion	form	string	No
ScannerVisionVersion	form	string	No
Guid	form	string	No
BeginScript	form	string	No
EndScript	form	string	No
TemplateType	form	TemplateType	No
General	form	IGeneral	No
Capture	form	ICapture	No
XmlMetadataImport	form	IXmlMetadataImport	No
Notifications	form	INotifications	No
Validator	form	IValidator	No

**TemplateType** Enum:
Workflow
FreeForm

**IGeneral** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
Icon	form	string	No
Schedule	form	ITemplateSchedule	No
Rejection	form	IRejection	No
BadDocumentRejection	form	IBadDocumentRejection	No
PdfLoadResolution	form	PdfLoadResolution?	No

**ITemplateSchedule** Parameters:
Name	Parameter	Data Type	Required
Time	form	TimeSpan?	No
EndTime	form	TimeSpan?	No
NoEndTime	form	bool?	No
Type	form	TemplateScheduleType?	No

**TemplateScheduleType** Enum:
Interval
Fixed

**IRejection** Parameters:
Name	Parameter	Data Type	Required
RejectAfter	form	int?	No
RejectionPath	form	string	No
ShareCredentials	form	ICredentials	No

**ICredentials** Parameters:
Name	Parameter	Data Type	Required	Description
Username	form	string	No
Password	form	string	No

**IBadDocumentRejection** Parameters:
Name	Parameter	Data Type	Required	Description
RejectionPath	form	string	No
ShareCredentials	form	ICredentials	No

**PdfLoadResolution** Enum:
Default	DEFAULT_PDF_LOAD_RESOLUTION
Dpi100	100
Dpi150	150
Dpi200	200
Dpi300	300
Dpi400	400
Dpi500	500
Dpi600	600

**ICapture** Parameters:
Name	Parameter	Data Type	Required	Description
CaptureSources	form	ReadOnlyCollection<ICaptureSource>	No

**IXmlMetadataImport** Parameters:
Name	Parameter	Data Type	Required
SampleDocumentName	form	string	No
TagMappings	form	ReadOnlyCollection<IXmlMetadataImportTagMapping>	No
NamespaceMappings	form	ReadOnlyCollection<IXmlMetadataImportNamespaceMapping>	No

**IXmlMetadataImportTagMapping** Parameters:
Name	Parameter	Data Type	Required	Description
XPathExpression	form	string	No
Metadata	form	IStringMetadata	No

**IStringMetadata** Parameters:
Name	Parameter	Data Type	Required
IsSecure	form	bool?	No
SampleValue	form	string	No
Value	form	string	No

**IXmlMetadataImportNamespaceMapping** Parameters:
Name	Parameter	Data Type	Required	Description
Prefix	form	string	No
Name	form	string	No

**INotifications** Parameters:
Name	Parameter	Data Type	Required	Description
Notifications	form	ReadOnlyCollection<INotification>	No

**INotification** Parameters:
Name	Parameter	Data Type	Required
Description	form	string	No
To	form	string	No
Subject	form	string	No
Body	form	string	No
Cc	form	string	No
Bcc	form	string	No
NotificationType	form	NotificationType?	No

**NotificationType** Enum:
FailureOnly	NOTIFICATION_TYPE_FAILURE_ONLY
SuccessOnly	NOTIFICATION_TYPE_SUCCESS_ONLY
Always	NOTIFICATION_TYPE_ALWAYS

**IValidator** Parameters:
Name	Parameter	Data Type	Required	Description
ValidationErrors	form	IValidationErrors	No
IsValid	form	bool	No

**IValidationErrors** Parameters:
Name	Parameter	Data Type	Required	Description
Errors	form	ReadOnlyCollection<IValidationError>	No

**IValidationError** Parameters:
Name	Parameter	Data Type	Required	Description
Property	form	string	No
ErrorMessage	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Brand}/scansettings/{TemplateGuid} HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TemplateGuid":"String","SelectedColour":"BlackAndWhite","SelectedOrientation":"Portrait","SelectedResolution":"Dpi100","SelectedSides":"Simplex","SelectedSize":"Auto","SelectedSource":"Adf","SelectedType":"Text","SelectedScanContinuously":"True","SelectedMixedSizes":"True","Brand":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'GetTemplateResponse' using the custom 'other' filter}No parameterless constructor defined for this object.