ScannerVision Web Server

<back to all web services

JsonFtpMetadataUploadRequest

Requires Authentication
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class JsonFtpMetadataUploadRequest extends JsonMetadataUploadRequest
    {
        
    }

    public static class JsonMetadataUploadRequest extends JsonRequestDto
    {
        public String UploadFileName = null;
        public String OriginalFileName = null;
        public String TemplateGuid = null;
        public String ClientIpAddress = null;
        public String ClientGuid = null;
        public String ClientName = null;
        public String ClientId = null;
        public String ClientSerialNumber = null;
        public String UserName = null;
        public String UserEmail = null;
        public String UserHomeFolder = null;
        public HashMap<String,String> TemplateQuestions = null;
        public HashMap<String,String> GlobalQuestions = null;
        
        public String getUploadFileName() { return UploadFileName; }
        public JsonMetadataUploadRequest setUploadFileName(String value) { this.UploadFileName = value; return this; }
        public String getOriginalFileName() { return OriginalFileName; }
        public JsonMetadataUploadRequest setOriginalFileName(String value) { this.OriginalFileName = value; return this; }
        public String getTemplateGuid() { return TemplateGuid; }
        public JsonMetadataUploadRequest setTemplateGuid(String value) { this.TemplateGuid = value; return this; }
        public String getClientIpAddress() { return ClientIpAddress; }
        public JsonMetadataUploadRequest setClientIpAddress(String value) { this.ClientIpAddress = value; return this; }
        public String getClientGuid() { return ClientGuid; }
        public JsonMetadataUploadRequest setClientGuid(String value) { this.ClientGuid = value; return this; }
        public String getClientName() { return ClientName; }
        public JsonMetadataUploadRequest setClientName(String value) { this.ClientName = value; return this; }
        public String getClientId() { return ClientId; }
        public JsonMetadataUploadRequest setClientId(String value) { this.ClientId = value; return this; }
        public String getClientSerialNumber() { return ClientSerialNumber; }
        public JsonMetadataUploadRequest setClientSerialNumber(String value) { this.ClientSerialNumber = value; return this; }
        public String getUserName() { return UserName; }
        public JsonMetadataUploadRequest setUserName(String value) { this.UserName = value; return this; }
        public String getUserEmail() { return UserEmail; }
        public JsonMetadataUploadRequest setUserEmail(String value) { this.UserEmail = value; return this; }
        public String getUserHomeFolder() { return UserHomeFolder; }
        public JsonMetadataUploadRequest setUserHomeFolder(String value) { this.UserHomeFolder = value; return this; }
        public HashMap<String,String> getTemplateQuestions() { return TemplateQuestions; }
        public JsonMetadataUploadRequest setTemplateQuestions(HashMap<String,String> value) { this.TemplateQuestions = value; return this; }
        public HashMap<String,String> getGlobalQuestions() { return GlobalQuestions; }
        public JsonMetadataUploadRequest setGlobalQuestions(HashMap<String,String> value) { this.GlobalQuestions = value; return this; }
    }

    public static class JsonRequestDto extends JsonDto
    {
        public String ClientCode = null;
        public String ClientRegistrationCode = null;
        public String Token = null;
        
        public String getClientCode() { return ClientCode; }
        public JsonRequestDto setClientCode(String value) { this.ClientCode = value; return this; }
        public String getClientRegistrationCode() { return ClientRegistrationCode; }
        public JsonRequestDto setClientRegistrationCode(String value) { this.ClientRegistrationCode = value; return this; }
        public String getToken() { return Token; }
        public JsonRequestDto setToken(String value) { this.Token = value; return this; }
    }

    public static class JsonDto
    {
        
    }

    public static class JsonMetadataUploadResponse extends JsonDto
    {
        public String TemplateGuid = null;
        public Boolean InError = null;
        public String ErrorMessage = null;
        
        public String getTemplateGuid() { return TemplateGuid; }
        public JsonMetadataUploadResponse setTemplateGuid(String value) { this.TemplateGuid = value; return this; }
        public Boolean isInError() { return InError; }
        public JsonMetadataUploadResponse setInError(Boolean value) { this.InError = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public JsonMetadataUploadResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
    }

}

Java 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>