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


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 SyncCompanyMembers
{
    /** @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 Determines if it is a test user */
    // @ApiMember(Description="Determines if it is a test user")
    public Test: boolean;

    /** @description 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 MemberCompanyId?: string;

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

TypeScript SyncCompanyMembers DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DeleteNonExisting: False,
	Test: False,
	MemberCompanyId: 00000000-0000-0000-0000-000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FailedSyncedMembers: 
	[
		{
			EmailAddress: String,
			FullName: String,
			Tags: 
			[
				{
					Id: 0,
					Name: String,
					DateAdded: "0001-01-01T00:00:00",
					Status: String
				}
			]
		}
	],
	SuccessSyncedMembers: 
	[
		{
			EmailAddress: String,
			FullName: String,
			Tags: 
			[
				{
					Id: 0,
					Name: String,
					DateAdded: "0001-01-01T00:00:00",
					Status: String
				}
			]
		}
	]
}