| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<BusinessEntityDocumentCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.BusinessEntity.ServiceModel">
<BeeNumber>0</BeeNumber>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<DocumentCategoryId>String</DocumentCategoryId>
<DocumentDefinition>String</DocumentDefinition>
<DocumentName>String</DocumentName>
<OverwriteIfExists>false</OverwriteIfExists>
<UserName>String</UserName>
</BusinessEntityDocumentCreate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BusinessEntityDocumentCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.BusinessEntity.ServiceModel">
<Links xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
<HateoasLink>
<Href>String</Href>
<Rel>String</Rel>
<Type>String</Type>
</HateoasLink>
</Links>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Nxnw.Adc.Common.ServiceModel">
<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>
<BeeDocumentGuid>0</BeeDocumentGuid>
</BusinessEntityDocumentCreateResponse>