POST | /documents |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@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)
open class DocumentUploadRequest : IPost
{
/**
* FileName
*/
@ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
var FileName:String? = null
/**
* ExternalID
*/
@ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
var ExternalId:String? = null
/**
* RequestStream needs to be base64 file content
*/
@ApiMember(Description="RequestStream needs to be base64 file content")
var RequestStream:String? = null
}
open class DocumentUploadResponse
{
var FileName:String? = null
var DownloadLink:String? = null
var ListLink:String? = null
var DaysToLive:Int? = null
var Message:String? = null
var IsSuccess:Boolean? = null
var ResponseStatus:ResponseStatus? = null
}
Kotlin DocumentUploadRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"FileName":"String","ExternalId":"String","RequestStream":"String"}
HTTP/1.1 200 OK Content-Type: application/json 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"}}}