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

export class MemberTag
{
    public Id: number;
    public Name: string;
    public DateAdded?: string;
    public Status: string;

    public constructor(init?: Partial<MemberTag>) { (Object as any).assign(this, init); }
}

export class MemberResponse
{
    public EmailAddress: string;
    public FullName: string;
    public Tags: MemberTag[];

    public constructor(init?: Partial<MemberResponse>) { (Object as any).assign(this, init); }
}

export class SyncMembersResponse
{
    public FailedSyncedMembers: MemberResponse[];
    public SuccessSyncedMembers: MemberResponse[];

    public constructor(init?: Partial<SyncMembersResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class SyncCompanyCustomerMembers implements ICompany
{
    /** @description 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 CompanyId?: string;

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

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

    /** @description Determines if it is a test user */
    // @ApiMember(Description="Determines if it is a test user")
    public Test: boolean;

    public constructor(init?: Partial<SyncCompanyCustomerMembers>) { (Object as any).assign(this, init); }
}

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