| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /articles | Add new article | Add 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="", IsRequired=true)
public var name:String
/**
*
*/
// @ApiMember(Description="", IsRequired=true)
public var articleTypeId:Int
/**
*
*/
// @ApiMember(Description="", IsRequired=true)
public var Description:String
/**
*
*/
// @ApiMember(Description="")
public var imageUrl:Uri
/**
*
*/
// @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
/**
* Query for specific services.
*/
// @ApiMember(Description="Query for specific services.", ParameterType="query")
public var serviceIds:[Int] = []
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 services:[ArticleServiceRelation] = []
public var serviceIds:[Int] = []
public var priceSign:String
required public init(){}
}
public class ArticleServiceRelation : BaseModel
{
// @Required()
public var companyId:String?
public var id:Int
// @Required()
public var serviceId:Int?
// @Required()
public var articleId:Int?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case companyId
case id
case serviceId
case articleId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
id = try container.decodeIfPresent(Int.self, forKey: .id)
serviceId = try container.decodeIfPresent(Int.self, forKey: .serviceId)
articleId = try container.decodeIfPresent(Int.self, forKey: .articleId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
if id != nil { try container.encode(id, forKey: .id) }
if serviceId != nil { try container.encode(serviceId, forKey: .serviceId) }
if articleId != nil { try container.encode(articleId, forKey: .articleId) }
}
}
public class BaseModel : Codable
{
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}