POST | /business-entities/{BeeNumber}/documents |
---|
namespace Nxnw.Adc.BusinessEntity.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type HateoasLink() =
member val Rel:String = null with get,set
member val Href:String = null with get,set
member val Type:String = null with get,set
[<AllowNullLiteral>]
type HateoasLinks() =
inherit ResizeArray<HateoasLink>()
[<AllowNullLiteral>]
type CreateResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val Links:HateoasLinks = null with get,set
[<AllowNullLiteral>]
type BusinessEntityDocumentCreateResponse() =
inherit CreateResponse()
member val BeeDocumentGuid:Int64 = new Int64() with get,set
[<AllowNullLiteral>]
type BusinessEntityDocumentCreate() =
interface IPost
[<ApiMember(IsRequired=true)>]
member val BeeNumber:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<ApiMember(IsRequired=true)>]
member val DocumentCategoryId:String = null with get,set
[<ApiMember(IsRequired=true)>]
member val DocumentName:String = null with get,set
member val UserName:String = null with get,set
[<ApiMember(IsRequired=true)>]
member val CreatedDate:DateTime = new DateTime() with get,set
[<ApiMember>]
member val DocumentDefinition:String = null with get,set
[<ApiMember>]
member val OverwriteIfExists:Boolean = new Boolean() with get,set
F# 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>