Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents
namespace Client_Initiations.ServiceModel.ClientUpload

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentUploadResponse() = 
        member val FileName:String = null with get,set
        member val DownloadLink:String = null with get,set
        member val ListLink:String = null with get,set
        member val DaysToLive:Int32 = new Int32() with get,set
        member val Message:String = null with get,set
        member val IsSuccess:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<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)>]
    [<AllowNullLiteral>]
    type DocumentUploadRequest() = 
        interface IPost
        ///<summary>
        ///FileName
        ///</summary>
        [<ApiMember(Description="FileName", IsRequired=true, ParameterType="path")>]
        member val FileName:String = null with get,set

        ///<summary>
        ///ExternalID
        ///</summary>
        [<ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")>]
        member val ExternalId:String = null with get,set

        ///<summary>
        ///RequestStream needs to be base64 file content
        ///</summary>
        [<ApiMember(Description="RequestStream needs to be base64 file content")>]
        member val RequestStream:String = null with get,set

F# 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-test.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"}}}