BokaMera.API.Host

<back to all web services

SyncCompanyMembers

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
PUT/mailchimp/member/company/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 SyncCompanyMembers
    {
        ///<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>
        ///Determines if it is a test user
        ///</summary>
        [ApiMember(Description="Determines if it is a test user")]
        public virtual bool Test { get; set; }

        ///<summary>
        ///The company id of member of which members you want to sync.
        ///</summary>
        [ApiMember(Description="The company id of member of which members you want to sync.")]
        public virtual Guid? MemberCompanyId { 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# SyncCompanyMembers DTOs

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

HTTP + XML

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

PUT /mailchimp/member/company/sync HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SyncCompanyMembers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <DeleteNonExisting>false</DeleteNonExisting>
  <MemberCompanyId>00000000-0000-0000-0000-000000000000</MemberCompanyId>
  <Test>false</Test>
</SyncCompanyMembers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SyncMembersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <FailedSyncedMembers>
    <MemberResponse>
      <EmailAddress>String</EmailAddress>
      <FullName>String</FullName>
      <Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/MailChimp.Net.Models">
        <d4p1:MemberTag>
          <d4p1:DateAdded>0001-01-01T00:00:00</d4p1:DateAdded>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Status>String</d4p1:Status>
        </d4p1:MemberTag>
      </Tags>
    </MemberResponse>
  </FailedSyncedMembers>
  <SuccessSyncedMembers>
    <MemberResponse>
      <EmailAddress>String</EmailAddress>
      <FullName>String</FullName>
      <Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/MailChimp.Net.Models">
        <d4p1:MemberTag>
          <d4p1:DateAdded>0001-01-01T00:00:00</d4p1:DateAdded>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Status>String</d4p1:Status>
        </d4p1:MemberTag>
      </Tags>
    </MemberResponse>
  </SuccessSyncedMembers>
</SyncMembersResponse>