BokaMera.API.Host

<back to all web services

GetCompanyMailchimpSyncExecution

Requires Authentication
The following routes are available for this service:
GET/company/mailchimp/syncExecutionsgets mailchimp sync executions in bokamera
"use strict";
export class QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Skip;
    /** @type {?number} */
    Take;
    /** @type {?string} */
    OrderBy;
    /** @type {?string} */
    OrderByDesc;
    /** @type {?string} */
    Include;
    /** @type {?string} */
    Fields;
    /** @type {?{ [index:string]: string; }} */
    Meta;
}
/** @typedef From {any} */
/** @typedef  Into {any} */
export class QueryDb extends QueryBase {
    /** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class MailchimpCompanySyncExecutionQueryResponse {
    /** @param {{MailchimpSyncExecutionId?:number,SuccessCount?:number,FailedCompanyIds?:string,Status?:string,Manual?:boolean,Errors?:string,CreatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    MailchimpSyncExecutionId;
    /** @type {number} */
    SuccessCount;
    /** @type {string} */
    FailedCompanyIds;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    Manual;
    /** @type {string} */
    Errors;
    /** @type {string} */
    CreatedDate;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class MailchimpSyncExecution extends BaseModel {
    /** @param {{Id?:number,SuccessCount?:number,FailedCompanyIds?:string,Status?:string,Errors?:string,Manual?:boolean,CompanyId?:string,BookMore?:boolean,CreatedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    SuccessCount;
    /** @type {?string} */
    FailedCompanyIds;
    /** @type {?string} */
    Status;
    /** @type {?string} */
    Errors;
    /** @type {boolean} */
    Manual;
    /** @type {?string} */
    CompanyId;
    /** @type {boolean} */
    BookMore;
    /** @type {string} */
    CreatedDate;
}
export class GetCompanyMailchimpSyncExecution extends QueryDb {
    /** @param {{CreatedDate?:string,CompanyId?:string,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CreatedDate;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
}
export class AccessKeyTypeResponse {
    /** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    KeyType;
    /** @type {string} */
    Description;
}
/** @typedef T {any} */
export class QueryResponse {
    /** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index:string]: string; },ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Offset;
    /** @type {number} */
    Total;
    /** @type {T[]} */
    Results = [];
    /** @type {?{ [index:string]: string; }} */
    Meta;
    /** @type {?ResponseStatus} */
    ResponseStatus;
}

JavaScript GetCompanyMailchimpSyncExecution DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /company/mailchimp/syncExecutions HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl

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

{"Offset":0,"Total":0,"Results":[{"MailchimpSyncExecutionId":0,"SuccessCount":0,"FailedCompanyIds":"String","Status":"String","Manual":false,"Errors":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}