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 Foundation
import ServiceStack

public class CreateArticle : Codable
{
    /**
    * 
    */
    // @ApiMember(Description="")
    public var companyId:String?

    /**
    * 
    */
    // @ApiMember(Description="")
    public var name:String

    /**
    * 
    */
    // @ApiMember(Description="", IsRequired=true)
    public var articleTypeId:Int

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

    /**
    * 
    */
    // @ApiMember(Description="")
    public var imageUrl:String

    /**
    * 
    */
    // @ApiMember(Description="", IsRequired=true)
    public var active:Bool

    /**
    * 
    */
    // @ApiMember(Description="", IsRequired=true)
    public var amount:Int

    /**
    * .
    */
    // @ApiMember(Description=".", IsRequired=true)
    public var price:Double

    /**
    * The payment currency id
    */
    // @ApiMember(Description="The payment currency id", IsRequired=true)
    public var currencyId:String

    required public init(){}
}

public class ArticleResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var name:String
    public var articleTypeId:Int
    public var Description:String
    public var imageUrl:String
    public var active:Bool
    public var amount:Int
    public var price:Double
    public var currencyId:String
    public var updatedDate:Date
    public var createdDate:Date
    public var modifiedDate:Date?

    required public init(){}
}


Swift CreateArticle 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.

POST /articles HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateArticle 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>
  <ImageUrl>String</ImageUrl>
  <Name>String</Name>
  <Price>0</Price>
</CreateArticle>
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>
  <ModifiedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </ModifiedDate>
  <Name>String</Name>
  <Price>0</Price>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</ArticleResponse>