BokaMera.API.Host

<back to all web services

UpdateArticleMappings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/articles/mappingsUpdate external article mappings for the company articlesCreate or update 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.*


@ValidateRequest(Validator="IsAuthenticated")
open class UpdateArticleMappings : ICompany
{
    /**
    * Company to update article mappings for
    */
    @ApiMember(Description="Company to update article mappings for")
    override var CompanyId:UUID? = null

    /**
    * The article mappings to create or update
    */
    @ApiMember(Description="The article mappings to create or update", IsRequired=true)
    open var ArticleMappings:ArrayList<ArticleMappingToHandle> = ArrayList<ArticleMappingToHandle>()
}

open class ArticleMappingToHandle
{
    /**
    * The id of an existing mapping to update; leave empty to create a new one
    */
    @ApiMember(Description="The id of an existing mapping to update; leave empty to create a new one")
    open var Id:UUID? = null

    /**
    * The BokaMera article id
    */
    @ApiMember(Description="The BokaMera article id")
    open var ArticleId:Int? = null

    /**
    * The Reference Type: StripeArticle = 1, EAccountingArticle = 2
    */
    @ApiMember(Description="The Reference Type: StripeArticle = 1, EAccountingArticle = 2")
    open var ReferenceType:String? = null

    /**
    * The external reference; Values for EAccountingArticle, StripeArticle
    */
    @ApiMember(Description="The external reference; Values for EAccountingArticle, StripeArticle")
    open var ExternalReference:String? = null
}

Kotlin UpdateArticleMappings 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.

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ArticleMappings: 
	[
		{
			Id: 00000000-0000-0000-0000-000000000000,
			ArticleId: 0,
			ReferenceType: String,
			ExternalReference: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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