BokaMera.API.Host

<back to all web services

GetMailchimpSyncExecution

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/mailchimp/syncExecutionsgets mailchimp sync executions in bokamera
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class MailchimpSyncExecution
        : BaseModel, IBaseModelCreated
    {
        public virtual int Id { get; set; }
        [Required]
        public virtual int SuccessCount { get; set; }

        public virtual string? FailedCompanyIds { get; set; }
        public virtual string? Status { get; set; }
        public virtual string? Errors { get; set; }
        public virtual bool Manual { get; set; }
        public virtual Guid? CompanyId { get; set; }
        public virtual bool BookMore { get; set; }
        [Required]
        public virtual DateTime CreatedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class GetMailchimpSyncExecution
        : QueryDb<MailchimpSyncExecution, MailchimpSyncExecutionQueryResponse>
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual DateTime? CreatedDate { get; set; }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }
    }

    public partial class MailchimpCompanySyncExecutionQueryResponse
    {
        public virtual int MailchimpSyncExecutionId { get; set; }
        public virtual int SuccessCount { get; set; }
        public virtual string FailedCompanyIds { get; set; }
        public virtual string Status { get; set; }
        public virtual bool Manual { get; set; }
        public virtual string Errors { get; set; }
        public virtual DateTime CreatedDate { get; set; }
    }

    public partial class MailchimpSyncExecutionQueryResponse
        : MailchimpCompanySyncExecutionQueryResponse
    {
        public virtual Guid? CompanyId { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# GetMailchimpSyncExecution 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.

GET /mailchimp/syncExecutions HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			CompanyId: 00000000-0000-0000-0000-000000000000,
			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
		}
	}
}