| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /articles/mappings | Get all external article mappings for the company articles | Get all mappings between BokaMera articles and articles in an external system, for example e-accounting |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class ArticleMappingsQuery
Implements ICompany
'''<Summary>
'''Company to show article mappings for
'''</Summary>
<ApiMember(Description:="Company to show article mappings for")>
Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<Summary>
'''The Reference Type to filter on: StripeArticle, EAccountingArticle
'''</Summary>
<ApiMember(Description:="The Reference Type to filter on: StripeArticle, EAccountingArticle")>
Public Overridable Property ReferenceType As String
'''<Summary>
'''Article to show mappings for
'''</Summary>
<ApiMember(Description:="Article to show mappings for")>
Public Overridable Property ArticleId As Integer?
End Class
End Namespace
End Namespace
VB.NET ArticleMappingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>