ScannerVision Web Server

<back to all web services

JsonMetadataUploadRequest

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 JsonMetadataUploadRequest extends JsonRequestDto
{
    public UploadFileName: string;
    public OriginalFileName: string;
    public TemplateGuid: string;
    public ClientIpAddress: string;
    public ClientGuid: string;
    public ClientName: string;
    public ClientId: string;
    public ClientSerialNumber: string;
    public UserName: string;
    public UserEmail: string;
    public UserHomeFolder: string;
    public TemplateQuestions: { [index: string]: string; };
    public GlobalQuestions: { [index: string]: string; };

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

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

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

TypeScript JsonMetadataUploadRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/JsonMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"UploadFileName":"String","OriginalFileName":"String","TemplateGuid":"String","ClientIpAddress":"String","ClientGuid":"String","ClientName":"String","ClientId":"String","ClientSerialNumber":"String","UserName":"String","UserEmail":"String","UserHomeFolder":"String","ClientCode":"String","ClientRegistrationCode":"String","Token":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TemplateGuid":"String","InError":false,"ErrorMessage":"String"}