BokaMera.API.Host

<back to all web services

SyncCompanyMembers

The following routes are available for this service:
PUT/mailchimp/member/company/syncSync Mailchimp members
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SyncCompanyMembers:
    # @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    delete_non_existing: bool = False
    """
    Should we delete emails that do not exist in BokaMera.
    """


    # @ApiMember(Description="Determines if it is a test user")
    test: bool = False
    """
    Determines if it is a test user
    """


    # @ApiMember(Description="Determines if it sync was executed manually by click in superAdmin")
    manual: bool = False
    """
    Determines if it sync was executed manually by click in superAdmin
    """


    # @ApiMember(Description="The company id of member of which members you want to sync.")
    member_company_id: Optional[str] = None
    """
    The company id of member of which members you want to sync.
    """

Python 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: testapi.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>
  <Manual>false</Manual>
  <MemberCompanyId>00000000-0000-0000-0000-000000000000</MemberCompanyId>
  <Test>false</Test>
</SyncCompanyMembers>