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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using MailChimp.Net.Models;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class MemberResponse
    {
        public MemberResponse()
        {
            Tags = new List<MemberTag>{};
        }

        public virtual string EmailAddress { get; set; }
        public virtual string FullName { get; set; }
        public virtual List<MemberTag> Tags { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class SyncCompanyCustomerMembers
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Should we delete emails that do not exist in BokaMera.
        ///</summary>
        [ApiMember(Description="Should we delete emails that do not exist in BokaMera.")]
        public virtual bool DeleteNonExisting { get; set; }

        ///<summary>
        ///Should we target only subscribed to newsletter customers.
        ///</summary>
        [ApiMember(Description="Should we target only subscribed to newsletter customers.")]
        public virtual bool OnlySubscribed { get; set; }

        ///<summary>
        ///Determines if it is a test user
        ///</summary>
        [ApiMember(Description="Determines if it is a test user")]
        public virtual bool Test { get; set; }
    }

    public partial class SyncMembersResponse
    {
        public SyncMembersResponse()
        {
            FailedSyncedMembers = new List<MemberResponse>{};
            SuccessSyncedMembers = new List<MemberResponse>{};
        }

        public virtual List<MemberResponse> FailedSyncedMembers { get; set; }
        public virtual List<MemberResponse> SuccessSyncedMembers { get; set; }
    }

}

namespace MailChimp.Net.Models
{
    public partial class MemberTag
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual DateTime? DateAdded { get; set; }
        public virtual string Status { get; set; }
    }

}

C# 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.bokamera.se 
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: 
			[
				{
					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
				}
			]
		}
	]
}