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 'package:servicestack/servicestack.dart';

// @ValidateRequest(Validator="IsAuthenticated")
class ArticleMappingsQuery implements ICompany, IConvertible
{
    /**
    * Company to show article mappings for
    */
    // @ApiMember(Description="Company to show article mappings for")
    String? CompanyId;

    /**
    * The Reference Type to filter on: StripeArticle, EAccountingArticle
    */
    // @ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")
    String ReferenceType = "";

    /**
    * Article to show mappings for
    */
    // @ApiMember(Description="Article to show mappings for")
    int? ArticleId;

    ArticleMappingsQuery({this.CompanyId,this.ReferenceType,this.ArticleId});
    ArticleMappingsQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        ReferenceType = json['ReferenceType'];
        ArticleId = json['ArticleId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'ReferenceType': ReferenceType,
        'ArticleId': ArticleId
    };

    getTypeName() => "ArticleMappingsQuery";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'ArticleMappingsQuery': TypeInfo(TypeOf.Class, create:() => ArticleMappingsQuery()),
});

Dart ArticleMappingsQuery 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 /articles/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfArticleMappingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleMappingResponse>
    <ArticleId>0</ArticleId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <ExternalReference>String</ExternalReference>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <ReferenceType>String</ReferenceType>
  </ArticleMappingResponse>
</ArrayOfArticleMappingResponse>