POST | /documents |
---|
import Foundation
import ServiceStack
// @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 class DocumentUploadRequest : IPost, Codable
{
/**
* FileName
*/
// @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
public var fileName:String
/**
* ExternalID
*/
// @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
public var externalId:String
/**
* RequestStream needs to be base64 file content
*/
// @ApiMember(Description="RequestStream needs to be base64 file content")
public var requestStream:String
required public init(){}
}
public class DocumentUploadResponse : Codable
{
public var fileName:String
public var downloadLink:String
public var listLink:String
public var daysToLive:Int
public var message:String
public var isSuccess:Bool
public var responseStatus:ResponseStatus
required public init(){}
}
Swift DocumentUploadRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}}