BokaMera.API.Host

SyncCompanyCustomerMembers

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports MailChimp.Net.Models

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class MemberResponse
            Public Sub New()
                Tags = New List(Of MemberTag)
            End Sub

            Public Overridable Property EmailAddress As String
            Public Overridable Property FullName As String
            Public Overridable Property Tags As List(Of MemberTag)
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class SyncCompanyCustomerMembers
            Implements 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 Overridable Property CompanyId As Nullable(Of Guid)

            '''<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 Overridable Property DeleteNonExisting As Boolean

            '''<Summary>
            '''Should we target only subscribed to newsletter customers.
            '''</Summary>
            <ApiMember(Description:="Should we target only subscribed to newsletter customers.")>
            Public Overridable Property OnlySubscribed As Boolean

            '''<Summary>
            '''Determines if it is a test user
            '''</Summary>
            <ApiMember(Description:="Determines if it is a test user")>
            Public Overridable Property Test As Boolean
        End Class

        Public Partial Class SyncMembersResponse
            Public Sub New()
                FailedSyncedMembers = New List(Of MemberResponse)
                SuccessSyncedMembers = New List(Of MemberResponse)
            End Sub

            Public Overridable Property FailedSyncedMembers As List(Of MemberResponse)
            Public Overridable Property SuccessSyncedMembers As List(Of MemberResponse)
        End Class
    End Namespace

    Namespace MailChimp.Net.Models

        Public Partial Class MemberTag
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property DateAdded As Nullable(Of Date)
            Public Overridable Property Status As String
        End Class
    End Namespace
End Namespace

VB.NET SyncCompanyCustomerMembers 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/customer/sync HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SyncCompanyCustomerMembers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DeleteNonExisting>false</DeleteNonExisting>
  <OnlySubscribed>false</OnlySubscribed>
  <Test>false</Test>
</SyncCompanyCustomerMembers>

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>