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 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SyncCompanyMembers implements IConvertible
{
    /**
    * Should we delete emails that do not exist in BokaMera.
    */
    // @ApiMember(Description="Should we delete emails that do not exist in BokaMera.")
    bool? DeleteNonExisting;

    /**
    * Determines if it is a test user
    */
    // @ApiMember(Description="Determines if it is a test user")
    bool? Test;

    /**
    * Determines if it sync was executed manually by click in superAdmin
    */
    // @ApiMember(Description="Determines if it sync was executed manually by click in superAdmin")
    bool? Manual;

    /**
    * 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.")
    String? MemberCompanyId;

    SyncCompanyMembers({this.DeleteNonExisting,this.Test,this.Manual,this.MemberCompanyId});
    SyncCompanyMembers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DeleteNonExisting = json['DeleteNonExisting'];
        Test = json['Test'];
        Manual = json['Manual'];
        MemberCompanyId = json['MemberCompanyId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DeleteNonExisting': DeleteNonExisting,
        'Test': Test,
        'Manual': Manual,
        'MemberCompanyId': MemberCompanyId
    };

    getTypeName() => "SyncCompanyMembers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'SyncCompanyMembers': TypeInfo(TypeOf.Class, create:() => SyncCompanyMembers()),
});

Dart SyncCompanyMembers DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"DeleteNonExisting":false,"Test":false,"Manual":false,"MemberCompanyId":"00000000-0000-0000-0000-000000000000"}