ScannerVision Web Server

HpUploadRequest

The following routes are available for this service:
All Verbs	/{Brand}/upload/{TemplateGuid}/{FileNameGuid}
All Verbs	/{Brand}/upload/{TemplateGuid}/{FileNameGuid}/hpupload


export enum Brand
{
    Desktop = 'Desktop',
    Hp = 'Hp',
    Kyocera = 'Kyocera',
    NeaScan = 'NeaScan',
    Samsung = 'Samsung',
    FujiXerox = 'FujiXerox',
    Ta = 'Ta',
    Utax = 'Utax',
    Epson = 'Epson',
    ScanFront400 = 'ScanFront400',
    Sharp = 'Sharp',
    Ricoh = 'Ricoh',
    FujiFilm = 'FujiFilm',
}

export class DtoBase
{
    public Brand: Brand;

    public constructor(init?: Partial<DtoBase>) { (Object as any).assign(this, init); }
}

export class RequestBase extends DtoBase
{

    public constructor(init?: Partial<RequestBase>) { super(init); (Object as any).assign(this, init); }
}

export class UploadRequest extends RequestBase
{
    public TemplateGuid: string;
    public FileNameGuid: string;

    public constructor(init?: Partial<UploadRequest>) { super(init); (Object as any).assign(this, init); }
}

export class HpUploadRequest extends UploadRequest
{

    public constructor(init?: Partial<HpUploadRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ResponseBase extends DtoBase
{
    public SelectedUiLanguage: string;
    public svSession: string;
    public Title: string;
    public PageTip: string;
    public NewBrowser: boolean;
    public ScanFront400TA: boolean;
    public ScanFront400UTAX: boolean;

    public constructor(init?: Partial<ResponseBase>) { super(init); (Object as any).assign(this, init); }
}

export class UploadResponse extends ResponseBase
{
    public InError: boolean;
    public ErrorMessage: string;
    public TemplateGuid: string;

    public constructor(init?: Partial<UploadResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}