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
namespace ScannerVision.WebService.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type Brand =
        | Desktop = 0
        | Hp = 1
        | Kyocera = 2
        | NeaScan = 3
        | Samsung = 4
        | FujiXerox = 5
        | Ta = 6
        | Utax = 7
        | Epson = 8
        | ScanFront400 = 9
        | Sharp = 10
        | Ricoh = 11
        | FujiFilm = 12

    [<AllowNullLiteral>]
    type DtoBase() = 
        member val Brand:Brand = new Brand() with get,set

    [<AllowNullLiteral>]
    type RequestBase() = 
        inherit DtoBase()

    [<AllowNullLiteral>]
    type UploadRequest() = 
        inherit RequestBase()
        member val TemplateGuid:String = null with get,set
        member val FileNameGuid:String = null with get,set

    [<AllowNullLiteral>]
    type HpUploadRequest() = 
        inherit UploadRequest()

    [<AllowNullLiteral>]
    type ResponseBase() = 
        inherit DtoBase()
        member val SelectedUiLanguage:String = null with get,set
        member val svSession:String = null with get,set
        member val Title:String = null with get,set
        member val PageTip:String = null with get,set
        member val NewBrowser:Boolean = new Boolean() with get,set
        member val ScanFront400TA:Boolean = new Boolean() with get,set
        member val ScanFront400UTAX:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type UploadResponse() = 
        inherit ResponseBase()
        member val InError:Boolean = new Boolean() with get,set
        member val ErrorMessage:String = null with get,set
        member val TemplateGuid:String = null with get,set

F# HpUploadRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"TemplateGuid":"String","FileNameGuid":"String","Brand":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}