NAV

BusinessEntityDocumentCreate

EntityAPI|BusinessEntityDocument

The following routes are available for this service:
POST	/business-entities/{BeeNumber}/documents


export class HateoasLink
{
    public rel?: string;
    public href?: string;
    public type?: string;

    public constructor(init?: Partial<HateoasLink>) { (Object as any).assign(this, init); }
}

export class HateoasLinks extends Array<HateoasLink>
{

    public constructor(init?: Partial<HateoasLinks>) { super(); (Object as any).assign(this, init); }
}

export class CreateResponse implements ICreateResponse
{
    public responseStatus?: ResponseStatus;
    public links?: HateoasLinks;

    public constructor(init?: Partial<CreateResponse>) { (Object as any).assign(this, init); }
}

export class BusinessEntityDocumentCreateResponse extends CreateResponse
{
    public beeDocumentGuid?: number;

    public constructor(init?: Partial<BusinessEntityDocumentCreateResponse>) { super(init); (Object as any).assign(this, init); }
}

export class BusinessEntityDocumentCreate implements IPost
{
    // @ApiMember(IsRequired=true)
    public beeNumber: number;

    // @ApiMember(IsRequired=true)
    public documentCategoryId?: string;

    // @ApiMember(IsRequired=true)
    public documentName?: string;

    public userName?: string;
    // @ApiMember(IsRequired=true)
    public createdDate?: string;

    // @ApiMember()
    public documentDefinition?: string;

    // @ApiMember()
    public overwriteIfExists?: boolean;

    public constructor(init?: Partial<BusinessEntityDocumentCreate>) { (Object as any).assign(this, init); }
}

TypeScript BusinessEntityDocumentCreate DTOs

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>