NAV

<back to all web services

BusinessEntityDocumentCreate

EntityAPI|BusinessEntityDocument
The following routes are available for this service:
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 .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
		}
	]
}