NAV

<back to all web services

BusinessEntityDocumentCreate

EntityAPI|BusinessEntityDocument
The following routes are available for this service:
POST/business-entities/{BeeNumber}/documents
BusinessEntityDocumentCreate Parameters:
NameParameterData TypeRequiredDescription
BeeNumberpathdecimal?Yes
DocumentCategoryIdbodystringYes
DocumentNamebodystringYes
UserNamebodystringNo
CreatedDatebodyDateTimeYes
DocumentDefinitionbodystringNo
OverwriteIfExistsbodyboolNo
BusinessEntityDocumentCreateResponse Parameters:
NameParameterData TypeRequiredDescription
BeeDocumentGuidformlongNo
CreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
LinksformHateoasLinksNo
HateoasLink Parameters:
NameParameterData TypeRequiredDescription
RelformstringNo
HrefformstringNo
TypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"beeNumber":0,"documentCategoryId":"String","documentName":"String","userName":"String","createdDate":"0001-01-01T00:00:00.0000000","documentDefinition":"String","overwriteIfExists":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}