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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	documentCategoryId: String,
	documentName: String,
	userName: String,
	createdDate: 0001-01-01T00:00:00,
	documentDefinition: String,
	overwriteIfExists: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	beeDocumentGuid: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	links: 
	[
		{
			rel: String,
			href: String,
			type: String
		}
	]
}