BokaMera.API.Host

<back to all web services

ArticleMappingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/articles/mappingsGet all external article mappings for the company articlesGet all mappings between BokaMera articles and articles in an external system, for example e-accounting
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
Object = TypeVar('Object')


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleMappingsQuery(ICompany):
    # @ApiMember(Description="Company to show article mappings for")
    company_id: Optional[str] = None
    """
    Company to show article mappings for
    """


    # @ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")
    reference_type: Optional[str] = None
    """
    The Reference Type to filter on: StripeArticle, EAccountingArticle
    """


    # @ApiMember(Description="Article to show mappings for")
    article_id: Optional[int] = None
    """
    Article to show mappings for
    """

Python ArticleMappingsQuery 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/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}]