| POST, PUT | /documents/download |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Client_Initiations.ServiceModel.ClientUpload
Namespace Global
Namespace Client_Initiations.ServiceModel.ClientUpload
Public Partial Class ClientDownloadRequest
Inherits DocumentRequestBase
Public Overridable Property FileName As String
'''<Summary>
'''Month
'''</Summary>
<ApiMember(Description:="Month", ExcludeInSchema:=true, IsRequired:=true, ParameterType:="path")>
Public Overridable Property Month As Integer
'''<Summary>
'''Day
'''</Summary>
<ApiMember(Description:="Day", ExcludeInSchema:=true, IsRequired:=true, ParameterType:="path")>
Public Overridable Property Day As Integer
End Class
Public Partial Class ClientDownloadResponse
Inherits ResponseBase
Public Overridable Property FileName As String
Public Overridable Property Stream As Stream
End Class
Public Partial Class DocumentRequestBase
'''<Summary>
'''ExternalID
'''</Summary>
<ApiMember(Description:="ExternalID", ExcludeInSchema:=true, IsRequired:=true, ParameterType:="path")>
Public Overridable Property ExternalId As String
End Class
Public Partial Class ResponseBase
Public Overridable Property Message As String
Public Overridable Property IsSuccess As Boolean
End Class
End Namespace
End Namespace
VB.NET ClientDownloadRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
Month: 0,
Day: 0,
ExternalId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
Message: String,
IsSuccess: False
}