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
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

    [<AllowNullLiteral>]
    type ArticleMappingResponse() = 
        ///<summary>
        ///The company id
        ///</summary>
        [<ApiMember(Description="The company id")>]
        member val CompanyId:Guid = new Guid() with get,set

        ///<summary>
        ///The id
        ///</summary>
        [<ApiMember(Description="The id")>]
        member val Id:Guid = new Guid() with get,set

        ///<summary>
        ///The BokaMera article id
        ///</summary>
        [<ApiMember(Description="The BokaMera article id")>]
        member val ArticleId:Int32 = new Int32() with get,set

        ///<summary>
        ///The external reference
        ///</summary>
        [<ApiMember(Description="The external reference")>]
        member val ExternalReference:String = null with get,set

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

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

        ///<summary>
        ///Id of the article mapping
        ///</summary>
        [<ApiMember(Description="Id of the article mapping", IsRequired=true, ParameterType="path")>]
        member val Id:Guid = new Guid() with get,set

F# DeleteArticleMapping DTOs

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

HTTP + OTHER

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

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