| POST | /business-entities/{BeeNumber}/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 HateoasLink:
rel: Optional[str] = None
href: Optional[str] = None
type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HateoasLinks(List[HateoasLink]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateResponse(ICreateResponse):
response_status: Optional[ResponseStatus] = None
links: Optional[HateoasLinks] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessEntityDocumentCreateResponse(CreateResponse):
bee_document_guid: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BusinessEntityDocumentCreate(IPost):
# @ApiMember(IsRequired=true)
bee_number: Optional[Decimal] = None
# @ApiMember(IsRequired=true)
document_category_id: Optional[str] = None
# @ApiMember(IsRequired=true)
document_name: Optional[str] = None
user_name: Optional[str] = None
# @ApiMember(IsRequired=true)
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember()
document_definition: Optional[str] = None
# @ApiMember()
overwrite_if_exists: Optional[bool] = None
Python BusinessEntityDocumentCreate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /business-entities/{BeeNumber}/documents HTTP/1.1
Host: extensions.avon.ca
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"beeNumber":0,"documentCategoryId":"String","documentName":"String","userName":"String","createdDate":"0001-01-01T00:00:00.0000000","documentDefinition":"String","overwriteIfExists":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"beeDocumentGuid":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"links":[{"rel":"String","href":"String","type":"String"}]}