BokaMera.API.Host

<back to all web services

CreateArticle

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/articlesAdd new articleAdd article to the company for the currently logged in user
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateArticle
{
    /**
    * 
    */
    @ApiMember(Description="")
    var CompanyId:UUID? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    var Name:String? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    var ArticleTypeId:Int? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    var Description:String? = null

    /**
    * 
    */
    @ApiMember(Description="")
    var ImageUrl:Uri? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    var Active:Boolean? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    var Amount:Int? = null

    /**
    * .
    */
    @ApiMember(Description=".", IsRequired=true)
    var Price:Double? = null

    /**
    * The payment currency id
    */
    @ApiMember(Description="The payment currency id", IsRequired=true)
    var CurrencyId:String? = null

    /**
    * Query for specific services.
    */
    @ApiMember(Description="Query for specific services.", ParameterType="query")
    var ServiceIds:ArrayList<Int>? = null
}

open class ArticleResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var Name:String? = null
    var ArticleTypeId:Int? = null
    var Description:String? = null
    var ImageUrl:String? = null
    var Active:Boolean? = null
    var Amount:Int? = null
    var Price:Double? = null
    var CurrencyId:String? = null
    var UpdatedDate:Date? = null
    var CreatedDate:Date? = null
    var Services:ArrayList<ArticleServiceRelation> = ArrayList<ArticleServiceRelation>()
    var ServiceIds:ArrayList<Int> = ArrayList<Int>()
    var PriceSign:String? = null
}

open class ArticleServiceRelation : BaseModel()
{
    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var ServiceId:Int? = null

    @Required()
    var ArticleId:Int? = null
}

open class BaseModel
{
}

Kotlin CreateArticle 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 /articles HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	ArticleTypeId: 0,
	Description: String,
	Active: False,
	Amount: 0,
	Price: 0,
	CurrencyId: String,
	ServiceIds: 
	[
		0
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	ArticleTypeId: 0,
	Description: String,
	ImageUrl: String,
	Active: False,
	Amount: 0,
	Price: 0,
	CurrencyId: String,
	Services: 
	[
		{
			Id: 0,
			ServiceId: 0,
			ArticleId: 0
		}
	],
	ServiceIds: 
	[
		0
	],
	PriceSign: String
}