BokaMera.API.Host

SyncCompanyMembers

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
PUT	/mailchimp/member/company/sync	sync mailchimp memebers

import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class SyncCompanyMembers : Codable
{
    /**
    * Should we delete emails that do not exist in BokaMera.
    */
    // @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    public var deleteNonExisting:Bool

    /**
    * Determines if it is a test user
    */
    // @ApiMember(Description="Determines if it is a test user")
    public var test:Bool

    /**
    * The company id of member of which members you want to sync.
    */
    // @ApiMember(Description="The company id of member of which members you want to sync.")
    public var memberCompanyId:String?

    required public init(){}
}

public class SyncMembersResponse : Codable
{
    public var failedSyncedMembers:[MemberResponse] = []
    public var successSyncedMembers:[MemberResponse] = []

    required public init(){}
}

public class MemberResponse : Codable
{
    public var emailAddress:String
    public var fullName:String
    public var tags:[MemberTag] = []

    required public init(){}
}

public class MemberTag : Codable
{
    public var id:Int
    public var name:String
    public var dateAdded:Date?
    public var status:String

    required public init(){}
}

Swift 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>