| POST | /documents |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentUploadResponse:
file_name: Optional[str] = None
download_link: Optional[str] = None
list_link: Optional[str] = None
days_to_live: int = 0
message: Optional[str] = None
is_success: bool = False
response_status: Optional[ResponseStatus] = None
# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentUploadRequest(IPost):
# @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
file_name: Optional[str] = None
"""
FileName
"""
# @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
external_id: Optional[str] = None
"""
ExternalID
"""
# @ApiMember(Description="RequestStream needs to be base64 file content")
request_stream: Optional[str] = None
"""
RequestStream needs to be base64 file content
"""
Python DocumentUploadRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
FileName: String,
ExternalId: String,
RequestStream: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}