Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /articles/{Id} | Updates article | Updates article for the currently logged in user |
---|
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class ArticleServiceRelation extends BaseModel
{
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public ServiceId: number;
// @Required()
public ArticleId: number;
public constructor(init?: Partial<ArticleServiceRelation>) { super(init); (Object as any).assign(this, init); }
}
export class ArticleResponse
{
public CompanyId: string;
public Id: number;
public Name: string;
public ArticleTypeId: number;
public Description: string;
public ImageUrl: string;
public Active: boolean;
public Amount: number;
public Price: number;
public CurrencyId: string;
public UpdatedDate: string;
public CreatedDate: string;
public Services: ArticleServiceRelation[];
public ServiceIds: number[];
public PriceSign: string;
public constructor(init?: Partial<ArticleResponse>) { (Object as any).assign(this, init); }
}
export class UpdateArticle implements ICompany
{
/** @description */
// @ApiMember(Description="", IsRequired=true, ParameterType="query")
public Id: number;
/** @description */
// @ApiMember(Description="")
public CompanyId?: string;
/** @description */
// @ApiMember(Description="")
public Name: string;
/** @description */
// @ApiMember(Description="")
public ArticleTypeId?: number;
/** @description */
// @ApiMember(Description="")
public Description: string;
/** @description */
// @ApiMember(Description="")
public ImageUrl: string;
/** @description */
// @ApiMember(Description="")
public Active?: boolean;
/** @description */
// @ApiMember(Description="")
public Amount: number;
/** @description . */
// @ApiMember(Description=".")
public Price: number;
/** @description The payment currency id */
// @ApiMember(Description="The payment currency id")
public CurrencyId: string;
/** @description Query for specific services. */
// @ApiMember(Description="Query for specific services.", ParameterType="query")
public ServiceIds: number[];
public constructor(init?: Partial<UpdateArticle>) { (Object as any).assign(this, 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>