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 |
---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type ArticleServiceRelation() =
inherit BaseModel()
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
member val Id:Int32 = new Int32() with get,set
[<Required>]
member val ServiceId:Int32 = new Int32() with get,set
[<Required>]
member val ArticleId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ArticleResponse() =
member val CompanyId:Guid = new Guid() with get,set
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val ArticleTypeId:Int32 = new Int32() with get,set
member val Description:String = null with get,set
member val ImageUrl:String = null with get,set
member val Active:Boolean = new Boolean() with get,set
member val Amount:Int32 = new Int32() with get,set
member val Price:Double = new Double() with get,set
member val CurrencyId:String = null with get,set
member val UpdatedDate:DateTime = new DateTime() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val Services:ResizeArray<ArticleServiceRelation> = new ResizeArray<ArticleServiceRelation>() with get,set
member val ServiceIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
member val PriceSign:String = null with get,set
[<AllowNullLiteral>]
type CreateArticle() =
///<summary>
///
///</summary>
[<ApiMember(Description="")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="", IsRequired=true)>]
member val Name:String = null with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="", IsRequired=true)>]
member val ArticleTypeId:Int32 = new Int32() with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="", IsRequired=true)>]
member val Description:String = null with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="")>]
member val ImageUrl:Uri = null with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="", IsRequired=true)>]
member val Active:Boolean = new Boolean() with get,set
///<summary>
///
///</summary>
[<ApiMember(Description="", IsRequired=true)>]
member val Amount:Int32 = new Int32() with get,set
///<summary>
///.
///</summary>
[<ApiMember(Description=".", IsRequired=true)>]
member val Price:Double = new Double() with get,set
///<summary>
///The payment currency id
///</summary>
[<ApiMember(Description="The payment currency id", IsRequired=true)>]
member val CurrencyId:String = null with get,set
///<summary>
///Query for specific services.
///</summary>
[<ApiMember(Description="Query for specific services.", ParameterType="query")>]
member val ServiceIds:Int32[] = [||] with get,set
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.
POST /articles HTTP/1.1
Host: api.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 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>
</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> <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>