| All Verbs | /{Brand}/upload/{TemplateGuid}/{FileNameGuid} | ||
|---|---|---|---|
| All Verbs | /{Brand}/upload/{TemplateGuid}/{FileNameGuid}/hpupload |
"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 UploadRequest extends RequestBase {
/** @param {{TemplateGuid?:string,FileNameGuid?:string,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
TemplateGuid;
/** @type {string} */
FileNameGuid;
}
export class HpUploadRequest extends UploadRequest {
/** @param {{TemplateGuid?:string,FileNameGuid?:string,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
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;
}
export class UploadResponse extends ResponseBase {
/** @param {{InError?:boolean,ErrorMessage?:string,TemplateGuid?:string,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 {boolean} */
InError;
/** @type {string} */
ErrorMessage;
/** @type {string} */
TemplateGuid;
}
JavaScript HpUploadRequest 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}/upload/{TemplateGuid}/{FileNameGuid} HTTP/1.1
Host: buildmax.org
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"TemplateGuid":"String","FileNameGuid":"String","Brand":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{Unable to show example output for type 'UploadResponse' using the custom 'other' filter}No parameterless constructor defined for this object.