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
import Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class ArticleTypeQuery : ICompany, Codable
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public var companyId:String?

    required public init(){}
}

public class ArticleTypesQueryResponse : Codable
{
    /**
    * The article type id
    */
    // @ApiMember(Description="The article type id")
    public var id:Int

    /**
    * The article type name
    */
    // @ApiMember(Description="The article type name")
    public var name:String

    /**
    * The article type description
    */
    // @ApiMember(Description="The article type description")
    public var Description:String

    required public init(){}
}


Swift ArticleTypeQuery DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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