BokaMera.API.Host

UpdateArticleMappings

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/articles/mappings	Update external article mappings for the company articles	Create or update mappings between BokaMera articles and articles in an external system, for example e-accounting

"use strict";
export class ArticleMappingToHandle {
    /** @param {{Id?:string,ArticleId?:number,ReferenceType?:string,ExternalReference?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The id of an existing mapping to update; leave empty to create a new one */
    Id;
    /**
     * @type {number}
     * @description The BokaMera article id */
    ArticleId;
    /**
     * @type {string}
     * @description The Reference Type: StripeArticle = 1, EAccountingArticle = 2 */
    ReferenceType;
    /**
     * @type {string}
     * @description The external reference; Values for EAccountingArticle, StripeArticle */
    ExternalReference;
}
export class UpdateArticleMappings {
    /** @param {{CompanyId?:string,ArticleMappings?:ArticleMappingToHandle[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Company to update article mappings for */
    CompanyId;
    /**
     * @type {ArticleMappingToHandle[]}
     * @description The article mappings to create or update */
    ArticleMappings = [];
}

JavaScript UpdateArticleMappings 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.

PUT /articles/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>