BokaMera.API.Host

<back to all web services

ArticleTypeQuery

Requires Authentication
The following routes are available for this service:
GET/articles/typesQuery article typesQuery article types
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ValidateRequest("IsAuthenticated")]
    public partial class ArticleTypeQuery
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }
    }

    public partial class ArticleTypesQueryResponse
    {
        ///<summary>
        ///The article type id
        ///</summary>
        [ApiMember(Description="The article type id")]
        public virtual int Id { get; set; }

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

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

}

C# ArticleTypeQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /articles/types HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Description: String
}