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.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class BusinessEntityDocumentCreate : IPost
{
    @ApiMember(IsRequired=true)
    var beeNumber:BigDecimal? = null

    @ApiMember(IsRequired=true)
    var documentCategoryId:String? = null

    @ApiMember(IsRequired=true)
    var documentName:String? = null

    var userName:String? = null
    @ApiMember(IsRequired=true)
    var createdDate:Date? = null

    @ApiMember()
    var documentDefinition:String? = null

    @ApiMember()
    var overwriteIfExists:Boolean? = null
}

open class BusinessEntityDocumentCreateResponse : CreateResponse()
{
    var beeDocumentGuid:Long? = null
}

open class CreateResponse : ICreateResponse
{
    var responseStatus:ResponseStatus? = null
    var links:HateoasLinks? = null
}

open class HateoasLinks : ArrayList<HateoasLink>()
{
}

open class HateoasLink
{
    var rel:String? = null
    var href:String? = null
    @SerializedName("type") var Type:String? = null
}

Kotlin BusinessEntityDocumentCreate DTOs

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"}]}