BokaMera.API.Host

<back to all web services

UpdateArticleMappings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/articles/mappingsUpdate external article mappings for the company articlesCreate or update mappings between BokaMera articles and articles in an external system, for example e-accounting
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class ArticleMappingToHandle
    {
        ///<summary>
        ///The id of an existing mapping to update; leave empty to create a new one
        ///</summary>
        [ApiMember(Description="The id of an existing mapping to update; leave empty to create a new one")]
        public virtual Guid? Id { get; set; }

        ///<summary>
        ///The BokaMera article id
        ///</summary>
        [ApiMember(Description="The BokaMera article id")]
        public virtual int ArticleId { get; set; }

        ///<summary>
        ///The Reference Type: StripeArticle = 1, EAccountingArticle = 2
        ///</summary>
        [ApiMember(Description="The Reference Type: StripeArticle = 1, EAccountingArticle = 2")]
        public virtual string ReferenceType { get; set; }

        ///<summary>
        ///The external reference; Values for EAccountingArticle, StripeArticle
        ///</summary>
        [ApiMember(Description="The external reference; Values for EAccountingArticle, StripeArticle")]
        public virtual string ExternalReference { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class UpdateArticleMappings
        : ICompany
    {
        ///<summary>
        ///Company to update article mappings for
        ///</summary>
        [ApiMember(Description="Company to update article mappings for")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The article mappings to create or update
        ///</summary>
        [ApiMember(Description="The article mappings to create or update", IsRequired=true)]
        public virtual List<ArticleMappingToHandle> ArticleMappings { get; set; } = [];
    }

}

C# UpdateArticleMappings 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.

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","ArticleMappings":[{"Id":"00000000-0000-0000-0000-000000000000","ArticleId":0,"ReferenceType":"String","ExternalReference":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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