Client_Initiations

DocumentUploadRequest

The following routes are available for this service:
POST	/documents

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

        <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
            Implements IPost
            '''<Summary>
            '''FileName
            '''</Summary>
            <ApiMember(Description:="FileName", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property FileName As String

            '''<Summary>
            '''ExternalID
            '''</Summary>
            <ApiMember(Description:="ExternalID", ExcludeInSchema:=true, IsRequired:=true, ParameterType:="path")>
            Public Overridable Property ExternalId As String

            '''<Summary>
            '''RequestStream needs to be base64 file content
            '''</Summary>
            <ApiMember(Description:="RequestStream needs to be base64 file content")>
            Public Overridable Property RequestStream As String
        End Class

        Public Partial Class DocumentUploadResponse
            Public Overridable Property FileName As String
            Public Overridable Property DownloadLink As String
            Public Overridable Property ListLink As String
            Public Overridable Property DaysToLive As Integer
            Public Overridable Property Message As String
            Public Overridable Property IsSuccess As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET DocumentUploadRequest 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 HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FileName":"String","ExternalId":"String","RequestStream":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}