ScannerVision Web Server

<back to all web services

JsonFtpMetadataUploadRequest

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ScannerVision.WebService.Json.Dto;

namespace ScannerVision.WebService.Json.Dto
{
    public partial class JsonDto
    {
    }

    public partial class JsonFtpMetadataUploadRequest
        : JsonMetadataUploadRequest
    {
    }

    public partial class JsonMetadataUploadRequest
        : JsonRequestDto
    {
        public virtual string UploadFileName { get; set; }
        public virtual string OriginalFileName { get; set; }
        public virtual string TemplateGuid { get; set; }
        public virtual string ClientIpAddress { get; set; }
        public virtual string ClientGuid { get; set; }
        public virtual string ClientName { get; set; }
        public virtual string ClientId { get; set; }
        public virtual string ClientSerialNumber { get; set; }
        public virtual string UserName { get; set; }
        public virtual string UserEmail { get; set; }
        public virtual string UserHomeFolder { get; set; }
        public virtual IDictionary<string, string> TemplateQuestions { get; set; }
        public virtual IDictionary<string, string> GlobalQuestions { get; set; }
    }

    public partial class JsonMetadataUploadResponse
        : JsonDto
    {
        public virtual string TemplateGuid { get; set; }
        public virtual bool InError { get; set; }
        public virtual string ErrorMessage { get; set; }
    }

    public partial class JsonRequestDto
        : JsonDto
    {
        public virtual string ClientCode { get; set; }
        public virtual string ClientRegistrationCode { get; set; }
        public virtual string Token { get; set; }
    }

}

C# 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>