Client_Initiations

<back to all web services

ClientDownloadRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/download
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
{
    public partial class ClientDownloadRequest
        : DocumentRequestBase
    {
        public virtual string FileName { get; set; }
        ///<summary>
        ///Month
        ///</summary>
        [ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")]
        public virtual int Month { get; set; }

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

    public partial class ClientDownloadResponse
        : ResponseBase
    {
        public virtual string FileName { get; set; }
        public virtual Stream Stream { get; set; }
    }

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

    public partial class ResponseBase
    {
        public virtual string Message { get; set; }
        public virtual bool IsSuccess { get; set; }
    }

}

C# ClientDownloadRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

POST /documents/download HTTP/1.1 
Host: initiation-test.sirva.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FileName":"String","Month":0,"Day":0,"ExternalId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"FileName":"String","Message":"String","IsSuccess":false}