BokaMera.API.Host

<back to all web services

DeleteArticleMapping

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/articles/mappings/{Id}Delete an external article mappingDelete a mapping between a BokaMera article and an article in an external system
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 ArticleMappingResponse
            '''<Summary>
            '''The company id
            '''</Summary>
            <ApiMember(Description:="The company id")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''The id
            '''</Summary>
            <ApiMember(Description:="The id")>
            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 external reference
            '''</Summary>
            <ApiMember(Description:="The external reference")>
            Public Overridable Property ExternalReference As String

            '''<Summary>
            '''The Reference Type
            '''</Summary>
            <ApiMember(Description:="The Reference Type")>
            Public Overridable Property ReferenceType As String
        End Class

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class DeleteArticleMapping
            Implements ICompany
            '''<Summary>
            '''Company to delete the article mapping for
            '''</Summary>
            <ApiMember(Description:="Company to delete the article mapping for")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''Id of the article mapping
            '''</Summary>
            <ApiMember(Description:="Id of the article mapping", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Guid
        End Class
    End Namespace
End Namespace

VB.NET DeleteArticleMapping 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.

DELETE /articles/mappings/{Id} HTTP/1.1 
Host: api.bookmore.dev 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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