ScannerVision Web Server

JsonFtpMetadataUploadRequest


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 JsonFtpMetadataUploadRequest extends JsonMetadataUploadRequest
{

    public constructor(init?: Partial<JsonFtpMetadataUploadRequest>) { 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 JsonFtpMetadataUploadRequest DTOs

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

HTTP + XML

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

POST /xml/reply/JsonFtpMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JsonFtpMetadataUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ClientCode>String</ClientCode>
  <ClientRegistrationCode>String</ClientRegistrationCode>
  <Token>String</Token>
  <ClientGuid>String</ClientGuid>
  <ClientId>String</ClientId>
  <ClientIpAddress>String</ClientIpAddress>
  <ClientName>String</ClientName>
  <ClientSerialNumber>String</ClientSerialNumber>
  <GlobalQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <OriginalFileName>String</OriginalFileName>
  <TemplateGuid>String</TemplateGuid>
  <TemplateQuestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <UploadFileName>String</UploadFileName>
  <UserEmail>String</UserEmail>
  <UserHomeFolder>String</UserHomeFolder>
  <UserName>String</UserName>
</JsonFtpMetadataUploadRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<JsonMetadataUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScannerVision.WebService.Json.Dto">
  <ErrorMessage>String</ErrorMessage>
  <InError>false</InError>
  <TemplateGuid>String</TemplateGuid>
</JsonMetadataUploadResponse>