BokaMera.API.Host

<back to all web services

ArticleMappingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/articles/mappingsGet all external article mappings for the company articlesGet all mappings between BokaMera articles and articles in an external system, for example e-accounting
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class ArticleMappingsQuery implements ICompany
    {
        /**
        * Company to show article mappings for
        */
        @ApiMember(Description="Company to show article mappings for")
        public UUID CompanyId = null;

        /**
        * The Reference Type to filter on: StripeArticle, EAccountingArticle
        */
        @ApiMember(Description="The Reference Type to filter on: StripeArticle, EAccountingArticle")
        public String ReferenceType = null;

        /**
        * Article to show mappings for
        */
        @ApiMember(Description="Article to show mappings for")
        public Integer ArticleId = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public ArticleMappingsQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getReferenceType() { return ReferenceType; }
        public ArticleMappingsQuery setReferenceType(String value) { this.ReferenceType = value; return this; }
        public Integer getArticleId() { return ArticleId; }
        public ArticleMappingsQuery setArticleId(Integer value) { this.ArticleId = value; return this; }
    }

}

Java ArticleMappingsQuery DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /articles/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		ArticleId: 0,
		ExternalReference: String,
		ReferenceType: String
	}
]