BokaMera.API.Host

<back to all web services

UpdateArticle

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/articles/{Id}Updates articleUpdates article for the currently logged in user
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UpdateArticle : ICompany
{
    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true, ParameterType="query")
    var Id:Int? = null

    /**
    * 
    */
    @ApiMember(Description="")
    var CompanyId:UUID? = null

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

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

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

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

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

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

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

    /**
    * The payment currency id
    */
    @ApiMember(Description="The payment currency id")
    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 UpdateArticle DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /articles/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateArticle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Amount>0</Amount>
  <ArticleTypeId>0</ArticleTypeId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CurrencyId>String</CurrencyId>
  <Description>String</Description>
  <Id>0</Id>
  <ImageUrl i:nil="true" />
  <Name>String</Name>
  <Price>0</Price>
  <ServiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ServiceIds>
</UpdateArticle>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArticleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Amount>0</Amount>
  <ArticleTypeId>0</ArticleTypeId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CurrencyId>String</CurrencyId>
  <Description>String</Description>
  <Id>0</Id>
  <ImageUrl>String</ImageUrl>
  <Name>String</Name>
  <Price>0</Price>
  <PriceSign>String</PriceSign>
  <ServiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ServiceIds>
  <Services xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
    <d2p1:ArticleServiceRelation>
      <d2p1:ArticleId>0</d2p1:ArticleId>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ServiceId>0</d2p1:ServiceId>
    </d2p1:ArticleServiceRelation>
  </Services>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</ArticleResponse>