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
GetCompanyMailchimpSyncExecution Parameters:
NameParameterData TypeRequiredDescription
CreatedDatequeryDateTime?NoThe company id, if empty will use the company id for the user you are logged in with.
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
MailchimpSyncExecution Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SuccessCountformintYes
FailedCompanyIdsformstringNo
StatusformstringNo
ErrorsformstringNo
ManualformboolNo
CompanyIdformGuid?No
BookMoreformboolNo
CreatedDateformDateTimeYes
MailchimpCompanySyncExecutionQueryResponse Parameters:
NameParameterData TypeRequiredDescription
MailchimpSyncExecutionIdformintNo
SuccessCountformintNo
FailedCompanyIdsformstringYes
StatusformstringYes
ManualformboolNo
ErrorsformstringYes
CreatedDateformDateTimeNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

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: api.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"}}}