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 .xml suffix or ?format=xml
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.sirva.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<DocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
<ExternalId>String</ExternalId>
<FileName>String</FileName>
<RequestStream>String</RequestStream>
</DocumentUploadRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DocumentUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload"> <DaysToLive>0</DaysToLive> <DownloadLink>String</DownloadLink> <FileName>String</FileName> <IsSuccess>false</IsSuccess> <ListLink>String</ListLink> <Message>String</Message> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </DocumentUploadResponse>