BokaMera.API.Host

<back to all web services

ArticleQuery

The following routes are available for this service:
GET/eaccounting/articles
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseArticleDto:
    article_id: Optional[str] = None
    article_price: Decimal = decimal.Decimal(0)
    article_name: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleQueryResponse(BaseArticleDto):
    unit_id: Optional[str] = None
    coding_id: Optional[str] = None
    vat_rate: Optional[str] = None
    vat_rate_percent: Optional[str] = None
    currency_sign: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleQuery(ICompany):
    company_id: Optional[str] = None

Python ArticleQuery 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.

GET /eaccounting/articles HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EAccountingDtos.ArticleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleId>00000000-0000-0000-0000-000000000000</ArticleId>
  <ArticleName>String</ArticleName>
  <ArticlePrice>0</ArticlePrice>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CodingId>String</CodingId>
  <CurrencySign>String</CurrencySign>
  <UnitId>String</UnitId>
  <VatRate>String</VatRate>
  <VatRatePercent>String</VatRatePercent>
</EAccountingDtos.ArticleQueryResponse>