BokaMera.API.Host

<back to all web services

UpdateArticle

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/articles/{Id}Updates articleUpdates article for the currently logged in user
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class ArticleServiceRelation
        : BaseModel
    {
        [Required]
        public virtual Guid CompanyId { get; set; }

        public virtual int Id { get; set; }
        [Required]
        public virtual int ServiceId { get; set; }

        [Required]
        public virtual int ArticleId { get; set; }
    }

    public partial class BaseModel
    {
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class ArticleResponse
    {
        public ArticleResponse()
        {
            Services = new List<ArticleServiceRelation>{};
            ServiceIds = new List<int>{};
        }

        public virtual Guid CompanyId { get; set; }
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int ArticleTypeId { get; set; }
        public virtual string Description { get; set; }
        public virtual string ImageUrl { get; set; }
        public virtual bool Active { get; set; }
        public virtual int Amount { get; set; }
        public virtual double Price { get; set; }
        public virtual string CurrencyId { get; set; }
        public virtual DateTime UpdatedDate { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual List<ArticleServiceRelation> Services { get; set; }
        public virtual List<int> ServiceIds { get; set; }
        public virtual string PriceSign { get; set; }
    }

    public partial class UpdateArticle
        : ICompany
    {
        public UpdateArticle()
        {
            ServiceIds = new int[]{};
        }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="", IsRequired=true, ParameterType="query")]
        public virtual int Id { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual string Name { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual int? ArticleTypeId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual string Description { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual Uri ImageUrl { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual bool? Active { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(Description="")]
        public virtual int Amount { get; set; }

        ///<summary>
        ///.
        ///</summary>
        [ApiMember(Description=".")]
        public virtual double Price { get; set; }

        ///<summary>
        ///The payment currency id
        ///</summary>
        [ApiMember(Description="The payment currency id")]
        public virtual string CurrencyId { get; set; }

        ///<summary>
        ///Query for specific services.
        ///</summary>
        [ApiMember(Description="Query for specific services.", ParameterType="query")]
        public virtual int[] ServiceIds { get; set; }
    }

}

C# UpdateArticle 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.

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>