ScannerVision Web Server

<back to all web services

JsonFileUploadRequest

Requires Authentication

export class JsonDto
{

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

export class JsonRequestDto extends JsonDto
{
    public ClientCode: string;
    public ClientRegistrationCode: string;
    public Token: string;

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

export class JsonFileUploadResponse extends JsonDto
{
    public ErrorMessage: string;
    public InError: boolean;
    public TemplateGuid: string;

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

export class JsonFileUploadRequest extends JsonRequestDto
{
    public FileName: string;
    public RequestStream: string;
    public TemplateGuid: string;

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

TypeScript JsonFileUploadRequest DTOs

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 /jsv/reply/JsonFileUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	TemplateGuid: String,
	ClientCode: String,
	ClientRegistrationCode: String,
	Token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorMessage: String,
	InError: False,
	TemplateGuid: String
}