| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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 |
|---|
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
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 Overridable Property Id As Guid?
'''<Summary>
'''The BokaMera article id
'''</Summary>
<ApiMember(Description:="The BokaMera article id")>
Public Overridable Property ArticleId As Integer
'''<Summary>
'''The Reference Type: StripeArticle = 1, EAccountingArticle = 2
'''</Summary>
<ApiMember(Description:="The Reference Type: StripeArticle = 1, EAccountingArticle = 2")>
Public Overridable Property ReferenceType As String
'''<Summary>
'''The external reference; Values for EAccountingArticle, StripeArticle
'''</Summary>
<ApiMember(Description:="The external reference; Values for EAccountingArticle, StripeArticle")>
Public Overridable Property ExternalReference As String
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class UpdateArticleMappings
Implements ICompany
'''<Summary>
'''Company to update article mappings for
'''</Summary>
<ApiMember(Description:="Company to update article mappings for")>
Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<Summary>
'''The article mappings to create or update
'''</Summary>
<ApiMember(Description:="The article mappings to create or update", IsRequired:=true)>
Public Overridable Property ArticleMappings As List(Of ArticleMappingToHandle) = New List(Of ArticleMappingToHandle)
End Class
End Namespace
End Namespace
VB.NET UpdateArticleMappings 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.
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>