BokaMera.API.Host

SyncCompanyCustomerMembers

The following routes are available for this service:
PUT	/mailchimp/member/company/customer/sync	Sync mailchimp members

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class SyncCompanyCustomerMembers : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    override var CompanyId:UUID? = null

    /**
    * Should we delete emails that do not exist in BokaMera.
    */
    @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    open var DeleteNonExisting:Boolean? = null

    /**
    * Should we target only subscribed to newsletter customers.
    */
    @ApiMember(Description="Should we target only subscribed to newsletter customers.")
    open var OnlySubscribed:Boolean? = null

    /**
    * Determines if it is a test user
    */
    @ApiMember(Description="Determines if it is a test user")
    open var Test:Boolean? = null
}

open class SyncMembersResponse
{
    open var FailedSyncedMembers:ArrayList<MemberResponse>? = null
    open var SuccessfullySyncedMemberCount:Int? = null
}

open class MemberResponse
{
    open var EmailAddress:String? = null
    open var FullName:String? = null
    open var Tags:ArrayList<MemberTag>? = null
}

open class MemberTag
{
    open var Name:String? = null
    open var Status:String? = null
}

Kotlin SyncCompanyCustomerMembers 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 /mailchimp/member/company/customer/sync HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	DeleteNonExisting: False,
	OnlySubscribed: False,
	Test: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FailedSyncedMembers: 
	[
		{
			EmailAddress: String,
			FullName: String,
			Tags: 
			[
				{
					Name: String,
					Status: String
				}
			]
		}
	],
	SuccessfullySyncedMemberCount: 0
}