NAV

<back to all web services

BusinessEntityDocumentCreate

EntityAPI|BusinessEntityDocument
The following routes are available for this service:
POST/business-entities/{BeeNumber}/documents
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class BusinessEntityDocumentCreate implements IPost
    {
        @ApiMember(IsRequired=true)
        public BigDecimal beeNumber = null;

        @ApiMember(IsRequired=true)
        public String documentCategoryId = null;

        @ApiMember(IsRequired=true)
        public String documentName = null;

        public String userName = null;
        @ApiMember(IsRequired=true)
        public Date createdDate = null;

        @ApiMember()
        public String documentDefinition = null;

        @ApiMember()
        public Boolean overwriteIfExists = null;
        
        public BigDecimal getBeeNumber() { return beeNumber; }
        public BusinessEntityDocumentCreate setBeeNumber(BigDecimal value) { this.beeNumber = value; return this; }
        public String getDocumentCategoryId() { return documentCategoryId; }
        public BusinessEntityDocumentCreate setDocumentCategoryId(String value) { this.documentCategoryId = value; return this; }
        public String getDocumentName() { return documentName; }
        public BusinessEntityDocumentCreate setDocumentName(String value) { this.documentName = value; return this; }
        public String getUserName() { return userName; }
        public BusinessEntityDocumentCreate setUserName(String value) { this.userName = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public BusinessEntityDocumentCreate setCreatedDate(Date value) { this.createdDate = value; return this; }
        public String getDocumentDefinition() { return documentDefinition; }
        public BusinessEntityDocumentCreate setDocumentDefinition(String value) { this.documentDefinition = value; return this; }
        public Boolean isOverwriteIfExists() { return overwriteIfExists; }
        public BusinessEntityDocumentCreate setOverwriteIfExists(Boolean value) { this.overwriteIfExists = value; return this; }
    }

    public static class BusinessEntityDocumentCreateResponse extends CreateResponse
    {
        public Long beeDocumentGuid = null;
        
        public Long getBeeDocumentGuid() { return beeDocumentGuid; }
        public BusinessEntityDocumentCreateResponse setBeeDocumentGuid(Long value) { this.beeDocumentGuid = value; return this; }
    }

    public static class CreateResponse implements ICreateResponse
    {
        public ResponseStatus responseStatus = null;
        public HateoasLinks links = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CreateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public HateoasLinks getLinks() { return links; }
        public CreateResponse setLinks(HateoasLinks value) { this.links = value; return this; }
    }

    public static class HateoasLinks extends ArrayList<HateoasLink>
    {
        
    }

    public static class HateoasLink
    {
        public String rel = null;
        public String href = null;
        public String type = null;
        
        public String getRel() { return rel; }
        public HateoasLink setRel(String value) { this.rel = value; return this; }
        public String getHref() { return href; }
        public HateoasLink setHref(String value) { this.href = value; return this; }
        public String getType() { return type; }
        public HateoasLink setType(String value) { this.type = value; return this; }
    }

}

Java BusinessEntityDocumentCreate DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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: text/csv
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"}]}