<back to all web services
BusinessEntityDocumentCreate
EntityAPI|BusinessEntityDocument
The following routes are available for this service:POST | /business-entities/{BeeNumber}/documents | | |
---|
BusinessEntityDocumentCreate Parameters:Name | Parameter | Data Type | Required | Description |
---|
BeeNumber | path | decimal? | Yes | |
DocumentCategoryId | body | string | Yes | |
DocumentName | body | string | Yes | |
UserName | body | string | No | |
CreatedDate | body | DateTime | Yes | |
DocumentDefinition | body | string | No | |
OverwriteIfExists | body | bool | No | |
BusinessEntityDocumentCreateResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
BeeDocumentGuid | form | long | No | |
CreateResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
ResponseStatus | form | ResponseStatus | No | |
Links | form | HateoasLinks | No | |
HateoasLink Parameters:Name | Parameter | Data Type | Required | Description |
---|
Rel | form | string | No | |
Href | form | string | No | |
Type | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + 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>