| POST | /{Brand}/resetscansettings/{TemplateGuid} |
|---|
"use strict";
/** @typedef {'Desktop'|'Hp'|'Kyocera'|'NeaScan'|'Samsung'|'FujiXerox'|'Ta'|'Utax'|'Epson'|'ScanFront400'|'Sharp'|'Ricoh'|'FujiFilm'} */
export var Brand;
(function (Brand) {
Brand["Desktop"] = "Desktop"
Brand["Hp"] = "Hp"
Brand["Kyocera"] = "Kyocera"
Brand["NeaScan"] = "NeaScan"
Brand["Samsung"] = "Samsung"
Brand["FujiXerox"] = "FujiXerox"
Brand["Ta"] = "Ta"
Brand["Utax"] = "Utax"
Brand["Epson"] = "Epson"
Brand["ScanFront400"] = "ScanFront400"
Brand["Sharp"] = "Sharp"
Brand["Ricoh"] = "Ricoh"
Brand["FujiFilm"] = "FujiFilm"
})(Brand || (Brand = {}));
export class DtoBase {
/** @param {{Brand?:Brand}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Brand} */
Brand;
}
export class RequestBase extends DtoBase {
/** @param {{Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResetScanSettingsRequest extends RequestBase {
/** @param {{TemplateGuid?:string,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
TemplateGuid;
}
export class ResponseBase extends DtoBase {
/** @param {{SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
SelectedUiLanguage;
/** @type {string} */
svSession;
/** @type {string} */
Title;
/** @type {string} */
PageTip;
/** @type {boolean} */
NewBrowser;
/** @type {boolean} */
ScanFront400TA;
/** @type {boolean} */
ScanFront400UTAX;
}
/** @typedef {'Workflow'|'FreeForm'} */
export var TemplateType;
(function (TemplateType) {
TemplateType["Workflow"] = "Workflow"
TemplateType["FreeForm"] = "FreeForm"
})(TemplateType || (TemplateType = {}));
/** @typedef {'Interval'|'Fixed'} */
export var TemplateScheduleType;
(function (TemplateScheduleType) {
TemplateScheduleType["Interval"] = "Interval"
TemplateScheduleType["Fixed"] = "Fixed"
})(TemplateScheduleType || (TemplateScheduleType = {}));
/** @typedef {'Default'|'Dpi100'|'Dpi150'|'Dpi200'|'Dpi300'|'Dpi400'|'Dpi500'|'Dpi600'} */
export var PdfLoadResolution;
(function (PdfLoadResolution) {
PdfLoadResolution["Default"] = "Default"
PdfLoadResolution["Dpi100"] = "Dpi100"
PdfLoadResolution["Dpi150"] = "Dpi150"
PdfLoadResolution["Dpi200"] = "Dpi200"
PdfLoadResolution["Dpi300"] = "Dpi300"
PdfLoadResolution["Dpi400"] = "Dpi400"
PdfLoadResolution["Dpi500"] = "Dpi500"
PdfLoadResolution["Dpi600"] = "Dpi600"
})(PdfLoadResolution || (PdfLoadResolution = {}));
/** @typedef {'FailureOnly'|'SuccessOnly'|'Always'} */
export var NotificationType;
(function (NotificationType) {
NotificationType["FailureOnly"] = "FailureOnly"
NotificationType["SuccessOnly"] = "SuccessOnly"
NotificationType["Always"] = "Always"
})(NotificationType || (NotificationType = {}));
export class ScanResponseBase extends ResponseBase {
/** @param {{Template?:IClientTemplate,GlobalQuestions?:IClientQuestion[],CanEnableScanButton?:boolean,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IClientTemplate} */
Template;
/** @type {IClientQuestion[]} */
GlobalQuestions;
/** @type {boolean} */
CanEnableScanButton;
}
export class GetTemplateResponse extends ScanResponseBase {
/** @param {{ServerAddress?:string,ServerPort?:number,Template?:IClientTemplate,GlobalQuestions?:IClientQuestion[],CanEnableScanButton?:boolean,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ServerAddress;
/** @type {number} */
ServerPort;
}
/** @typedef {'BlackAndWhite'|'Greyscale'|'Colour'|'Auto'} */
export var ScanColour;
(function (ScanColour) {
ScanColour["BlackAndWhite"] = "BlackAndWhite"
ScanColour["Greyscale"] = "Greyscale"
ScanColour["Colour"] = "Colour"
ScanColour["Auto"] = "Auto"
})(ScanColour || (ScanColour = {}));
/** @typedef {'Portrait'|'Landscape'} */
export var ScanOrientation;
(function (ScanOrientation) {
ScanOrientation["Portrait"] = "Portrait"
ScanOrientation["Landscape"] = "Landscape"
})(ScanOrientation || (ScanOrientation = {}));
/** @typedef {'Dpi100'|'Dpi200'|'Dpi300'|'Dpi400'|'Dpi600'} */
export var ScanResolution;
(function (ScanResolution) {
ScanResolution["Dpi100"] = "Dpi100"
ScanResolution["Dpi200"] = "Dpi200"
ScanResolution["Dpi300"] = "Dpi300"
ScanResolution["Dpi400"] = "Dpi400"
ScanResolution["Dpi600"] = "Dpi600"
})(ScanResolution || (ScanResolution = {}));
/** @typedef {'Simplex'|'Duplex'} */
export var ScanSide;
(function (ScanSide) {
ScanSide["Simplex"] = "Simplex"
ScanSide["Duplex"] = "Duplex"
})(ScanSide || (ScanSide = {}));
/** @typedef {'Auto'|'A3'|'A4'|'A5'|'B4'|'B5'|'Letter'|'Legal'|'Executive'|'Folio'|'AutoLong'|'A4R'|'A5R'|'A6R'|'B6R'} */
export var ScanSize;
(function (ScanSize) {
ScanSize["Auto"] = "Auto"
ScanSize["A3"] = "A3"
ScanSize["A4"] = "A4"
ScanSize["A5"] = "A5"
ScanSize["B4"] = "B4"
ScanSize["B5"] = "B5"
ScanSize["Letter"] = "Letter"
ScanSize["Legal"] = "Legal"
ScanSize["Executive"] = "Executive"
ScanSize["Folio"] = "Folio"
ScanSize["AutoLong"] = "AutoLong"
ScanSize["A4R"] = "A4R"
ScanSize["A5R"] = "A5R"
ScanSize["A6R"] = "A6R"
ScanSize["B6R"] = "B6R"
})(ScanSize || (ScanSize = {}));
/** @typedef {'Adf'|'Glass'|'Auto'} */
export var ScanSource;
(function (ScanSource) {
ScanSource["Adf"] = "Adf"
ScanSource["Glass"] = "Glass"
ScanSource["Auto"] = "Auto"
})(ScanSource || (ScanSource = {}));
/** @typedef {'Text'|'Photo'|'TextAndPhoto'} */
export var ScanType;
(function (ScanType) {
ScanType["Text"] = "Text"
ScanType["Photo"] = "Photo"
ScanType["TextAndPhoto"] = "TextAndPhoto"
})(ScanType || (ScanType = {}));
/** @typedef {'True'|'False'} */
export var BoolSetting;
(function (BoolSetting) {
BoolSetting["True"] = "True"
BoolSetting["False"] = "False"
})(BoolSetting || (BoolSetting = {}));
export class GetScanSettingsResponse extends GetTemplateResponse {
/** @param {{ScanSettings?:IScanSettings,ColourLabel?:string,OrientationLabel?:string,ResolutionLabel?:string,SidesLabel?:string,SizeLabel?:string,SourceLabel?:string,TypeLabel?:string,ScanContinuouslyLabel?:string,MixedSizesLabel?:string,ServerAddress?:string,ServerPort?:number,Template?:IClientTemplate,GlobalQuestions?:IClientQuestion[],CanEnableScanButton?:boolean,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IScanSettings} */
ScanSettings;
/** @type {string} */
ColourLabel;
/** @type {string} */
OrientationLabel;
/** @type {string} */
ResolutionLabel;
/** @type {string} */
SidesLabel;
/** @type {string} */
SizeLabel;
/** @type {string} */
SourceLabel;
/** @type {string} */
TypeLabel;
/** @type {string} */
ScanContinuouslyLabel;
/** @type {string} */
MixedSizesLabel;
}
JavaScript ResetScanSettingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /{Brand}/resetscansettings/{TemplateGuid} HTTP/1.1
Host: buildmax.org
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"TemplateGuid":"String","Brand":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{Unable to show example output for type 'GetScanSettingsResponse' using the custom 'other' filter}No parameterless constructor defined for this object.