POST | /business-entities/{BeeNumber}/documents |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Nxnw.Adc.BusinessEntity.ServiceModel;
using Nxnw.Adc.Common.ServiceModel;
namespace Nxnw.Adc.BusinessEntity.ServiceModel
{
public partial class BusinessEntityDocumentCreate
: IPost
{
[ApiMember(IsRequired=true)]
public virtual decimal? BeeNumber { get; set; }
[ApiMember(IsRequired=true)]
public virtual string DocumentCategoryId { get; set; }
[ApiMember(IsRequired=true)]
public virtual string DocumentName { get; set; }
public virtual string UserName { get; set; }
[ApiMember(IsRequired=true)]
public virtual DateTime CreatedDate { get; set; }
[ApiMember]
public virtual string DocumentDefinition { get; set; }
[ApiMember]
public virtual bool OverwriteIfExists { get; set; }
}
public partial class BusinessEntityDocumentCreateResponse
: CreateResponse
{
public virtual long BeeDocumentGuid { get; set; }
}
}
namespace Nxnw.Adc.Common.ServiceModel
{
public partial class CreateResponse
: ICreateResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual HateoasLinks Links { get; set; }
}
public partial class HateoasLink
{
public virtual string Rel { get; set; }
public virtual string Href { get; set; }
public virtual string Type { get; set; }
}
public partial class HateoasLinks
: List<HateoasLink>
{
}
}
C# 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>