BokaMera.API.Host

<back to all web services

SyncCompanyCustomerMembers

Requires Authentication
The following routes are available for this service:
PUT/mailchimp/member/company/customer/syncsync mailchimp memebers
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    public static class SyncCompanyCustomerMembers implements 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.")
        public UUID CompanyId = null;

        /**
        * Should we delete emails that do not exist in BokaMera.
        */
        @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
        public Boolean DeleteNonExisting = null;

        /**
        * Should we target only subscribed to newsletter customers.
        */
        @ApiMember(Description="Should we target only subscribed to newsletter customers.")
        public Boolean OnlySubscribed = null;

        /**
        * Determines if it is a test user
        */
        @ApiMember(Description="Determines if it is a test user")
        public Boolean Test = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SyncCompanyCustomerMembers setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isDeleteNonExisting() { return DeleteNonExisting; }
        public SyncCompanyCustomerMembers setDeleteNonExisting(Boolean value) { this.DeleteNonExisting = value; return this; }
        public Boolean isOnlySubscribed() { return OnlySubscribed; }
        public SyncCompanyCustomerMembers setOnlySubscribed(Boolean value) { this.OnlySubscribed = value; return this; }
        public Boolean isTest() { return Test; }
        public SyncCompanyCustomerMembers setTest(Boolean value) { this.Test = value; return this; }
    }

    public static class SyncMembersResponse
    {
        public ArrayList<MemberResponse> FailedSyncedMembers = null;
        public ArrayList<MemberResponse> SuccessSyncedMembers = null;
        
        public ArrayList<MemberResponse> getFailedSyncedMembers() { return FailedSyncedMembers; }
        public SyncMembersResponse setFailedSyncedMembers(ArrayList<MemberResponse> value) { this.FailedSyncedMembers = value; return this; }
        public ArrayList<MemberResponse> getSuccessSyncedMembers() { return SuccessSyncedMembers; }
        public SyncMembersResponse setSuccessSyncedMembers(ArrayList<MemberResponse> value) { this.SuccessSyncedMembers = value; return this; }
    }

    public static class MemberResponse
    {
        public String EmailAddress = null;
        public String FullName = null;
        public ArrayList<MemberTag> Tags = null;
        
        public String getEmailAddress() { return EmailAddress; }
        public MemberResponse setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getFullName() { return FullName; }
        public MemberResponse setFullName(String value) { this.FullName = value; return this; }
        public ArrayList<MemberTag> getTags() { return Tags; }
        public MemberResponse setTags(ArrayList<MemberTag> value) { this.Tags = value; return this; }
    }

    public static class MemberTag
    {
        public Integer Id = null;
        public String Name = null;
        public Date DateAdded = null;
        public String Status = null;
        
        public Integer getId() { return Id; }
        public MemberTag setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public MemberTag setName(String value) { this.Name = value; return this; }
        public Date getDateAdded() { return DateAdded; }
        public MemberTag setDateAdded(Date value) { this.DateAdded = value; return this; }
        public String getStatus() { return Status; }
        public MemberTag setStatus(String value) { this.Status = value; return this; }
    }

}

Java SyncCompanyCustomerMembers DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","DeleteNonExisting":false,"OnlySubscribed":false,"Test":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FailedSyncedMembers":[{"EmailAddress":"String","FullName":"String","Tags":[{"Id":0,"Name":"String","DateAdded":"0001-01-01T00:00:00","Status":"String"}]}],"SuccessSyncedMembers":[{"EmailAddress":"String","FullName":"String","Tags":[{"Id":0,"Name":"String","DateAdded":"0001-01-01T00:00:00","Status":"String"}]}]}