ScannerVision Web Server

<back to all web services

HpUploadRequest

Requires Authentication
The following routes are available for this service:
All Verbs/{Brand}/upload/{TemplateGuid}/{FileNameGuid}
All Verbs/{Brand}/upload/{TemplateGuid}/{FileNameGuid}/hpupload
UploadRequest Parameters:
NameParameterData TypeRequiredDescription
TemplateGuidformstringNo
FileNameGuidformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
BrandformBrandNo
Brand Enum:
Desktop
Hp
Kyocera
NeaScan
Samsung
FujiXerox
Ta
Utax
Epson
ScanFront400
Sharp
Ricoh
FujiFilm
Brother
UploadResponse Parameters:
NameParameterData TypeRequiredDescription
InErrorformboolNo
ErrorMessageformstringNo
TemplateGuidformstringNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
SelectedUiLanguageformstringNo
svSessionformstringNo
TitleformstringNo
PageTipformstringNo
NewBrowserformboolNo
ScanFront400TAformboolNo
ScanFront400UTAXformboolNo

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

HTTP + JSV

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: dmsshow.kyocerasolutions.cz 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TemplateGuid: String,
	FileNameGuid: String,
	Brand: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	InError: False,
	ErrorMessage: String,
	TemplateGuid: String,
	SelectedUiLanguage: String,
	svSession: String,
	Title: String,
	PageTip: String,
	NewBrowser: False,
	ScanFront400TA: False,
	ScanFront400UTAX: False,
	Brand: Desktop
}