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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleMappingResponse:
    # @ApiMember(Description="The company id")
    company_id: Optional[str] = None
    """
    The company id
    """


    # @ApiMember(Description="The id")
    id: Optional[str] = None
    """
    The id
    """


    # @ApiMember(Description="The BokaMera article id")
    article_id: int = 0
    """
    The BokaMera article id
    """


    # @ApiMember(Description="The external reference")
    external_reference: Optional[str] = None
    """
    The external reference
    """


    # @ApiMember(Description="The Reference Type")
    reference_type: Optional[str] = None
    """
    The Reference Type
    """


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteArticleMapping(ICompany):
    # @ApiMember(Description="Company to delete the article mapping for")
    company_id: Optional[str] = None
    """
    Company to delete the article mapping for
    """


    # @ApiMember(Description="Id of the article mapping", IsRequired=true, ParameterType="path")
    id: Optional[str] = None
    """
    Id of the article mapping
    """

Python DeleteArticleMapping DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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