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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/JsonFtpMetadataUploadRequest HTTP/1.1 
Host: buildmax.org 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
Content-Length: length

{
	TemplateGuid: String,
	InError: False,
	ErrorMessage: String
}