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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ArticleTypesQueryResponse() = 
        ///<summary>
        ///The article type id
        ///</summary>
        [<ApiMember(Description="The article type id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The article type name
        ///</summary>
        [<ApiMember(Description="The article type name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The article type description
        ///</summary>
        [<ApiMember(Description="The article type description")>]
        member val Description:String = null with get,set

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type ArticleTypeQuery() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# 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.bookmore.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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