ScannerVision Web Server

<back to all web services

JsonFtpMetadataUploadRequest

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class JsonFtpMetadataUploadRequest : JsonMetadataUploadRequest()
{
}

open class JsonMetadataUploadRequest : JsonRequestDto()
{
    open var UploadFileName:String? = null
    open var OriginalFileName:String? = null
    open var TemplateGuid:String? = null
    open var ClientIpAddress:String? = null
    open var ClientGuid:String? = null
    open var ClientName:String? = null
    open var ClientId:String? = null
    open var ClientSerialNumber:String? = null
    open var UserName:String? = null
    open var UserEmail:String? = null
    open var UserHomeFolder:String? = null
    open var TemplateQuestions:HashMap<String,String>? = null
    open var GlobalQuestions:HashMap<String,String>? = null
}

open class JsonRequestDto : JsonDto()
{
    open var ClientCode:String? = null
    open var ClientRegistrationCode:String? = null
    open var Token:String? = null
}

open class JsonDto
{
}

open class JsonMetadataUploadResponse : JsonDto()
{
    open var TemplateGuid:String? = null
    open var InError:Boolean? = null
    open var ErrorMessage:String? = null
}

Kotlin 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: dmsshow.kyocerasolutions.cz 
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>