Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /articles/{Id} | Updates article | Updates article for the currently logged in user |
---|
import Foundation
import ServiceStack
public class UpdateArticle : ICompany, Codable
{
/**
*
*/
// @ApiMember(Description="", IsRequired=true, ParameterType="query")
public var id:Int
/**
*
*/
// @ApiMember(Description="")
public var companyId:String?
/**
*
*/
// @ApiMember(Description="")
public var name:String
/**
*
*/
// @ApiMember(Description="")
public var articleTypeId:Int?
/**
*
*/
// @ApiMember(Description="")
public var Description:String
/**
*
*/
// @ApiMember(Description="")
public var imageUrl:Uri
/**
*
*/
// @ApiMember(Description="")
public var active:Bool?
/**
*
*/
// @ApiMember(Description="")
public var amount:Int
/**
* .
*/
// @ApiMember(Description=".")
public var price:Double
/**
* The payment currency id
*/
// @ApiMember(Description="The payment currency id")
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 .xml suffix or ?format=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>