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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type ArticleMappingsQuery() = 
        ///<summary>
        ///Company to show article mappings for
        ///</summary>
        [<ApiMember(Description="Company to show article mappings for")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The Reference Type to filter on: StripeArticle, EAccountingArticle
        ///</summary>
        [<ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")>]
        member val ReferenceType:String = null with get,set

        ///<summary>
        ///Article to show mappings for
        ///</summary>
        [<ApiMember(Description="Article to show mappings for")>]
        member val ArticleId:Nullable<Int32> = new Nullable<Int32>() with get,set

F# ArticleMappingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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