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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class DeleteArticleMapping implements ICompany
    {
        /**
        * Company to delete the article mapping for
        */
        @ApiMember(Description="Company to delete the article mapping for")
        public UUID CompanyId = null;

        /**
        * Id of the article mapping
        */
        @ApiMember(Description="Id of the article mapping", IsRequired=true, ParameterType="path")
        public UUID Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteArticleMapping setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getId() { return Id; }
        public DeleteArticleMapping setId(UUID value) { this.Id = value; return this; }
    }

    public static class ArticleMappingResponse
    {
        /**
        * The company id
        */
        @ApiMember(Description="The company id")
        public UUID CompanyId = null;

        /**
        * The id
        */
        @ApiMember(Description="The id")
        public UUID Id = null;

        /**
        * The BokaMera article id
        */
        @ApiMember(Description="The BokaMera article id")
        public Integer ArticleId = null;

        /**
        * The external reference
        */
        @ApiMember(Description="The external reference")
        public String ExternalReference = null;

        /**
        * The Reference Type
        */
        @ApiMember(Description="The Reference Type")
        public String ReferenceType = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public ArticleMappingResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getId() { return Id; }
        public ArticleMappingResponse setId(UUID value) { this.Id = value; return this; }
        public Integer getArticleId() { return ArticleId; }
        public ArticleMappingResponse setArticleId(Integer value) { this.ArticleId = value; return this; }
        public String getExternalReference() { return ExternalReference; }
        public ArticleMappingResponse setExternalReference(String value) { this.ExternalReference = value; return this; }
        public String getReferenceType() { return ReferenceType; }
        public ArticleMappingResponse setReferenceType(String value) { this.ReferenceType = value; return this; }
    }

}

Java 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"}