Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Client_Initiations.ServiceModel.ClientUpload;

namespace Client_Initiations.ServiceModel.ClientUpload
{
    [ApiResponse(Description="Returned if a client is not authorized to upload a receipt", StatusCode=401)]
    [ApiResponse(Description="Returned if the validation failed for the input expense receipt", StatusCode=412)]
    [ApiResponse(Description="Returned if the corresponding expense report was not found", StatusCode=404)]
    [ApiResponse(Description="Returned if the call to the expense service failed", StatusCode=400)]
    public partial class DocumentUploadRequest
        : IPost
    {
        ///<summary>
        ///FileName
        ///</summary>
        [ApiMember(Description="FileName", IsRequired=true, ParameterType="path")]
        public virtual string FileName { get; set; }

        ///<summary>
        ///ExternalID
        ///</summary>
        [ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")]
        public virtual string ExternalId { get; set; }

        ///<summary>
        ///RequestStream needs to be base64 file content
        ///</summary>
        [ApiMember(Description="RequestStream needs to be base64 file content")]
        public virtual string RequestStream { get; set; }
    }

    public partial class DocumentUploadResponse
    {
        public virtual string FileName { get; set; }
        public virtual string DownloadLink { get; set; }
        public virtual string ListLink { get; set; }
        public virtual int DaysToLive { get; set; }
        public virtual string Message { get; set; }
        public virtual bool IsSuccess { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# DocumentUploadRequest 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 /documents HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	ExternalId: String,
	RequestStream: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	DownloadLink: String,
	ListLink: String,
	DaysToLive: 0,
	Message: String,
	IsSuccess: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}