BokaMera.API.Host

<back to all web services

CreateMailchimpProfile

Requires Authentication
The following routes are available for this service:
PUT/mailchimp/profilecreates mailchimp profile in bokamera
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class MailchimpConfig implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $MailChimpApiKey='',
        /** @var string */
        public string $MailChimpAudienceId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['MailChimpApiKey'])) $this->MailChimpApiKey = $o['MailChimpApiKey'];
        if (isset($o['MailChimpAudienceId'])) $this->MailChimpAudienceId = $o['MailChimpAudienceId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->MailChimpApiKey)) $o['MailChimpApiKey'] = $this->MailChimpApiKey;
        if (isset($this->MailChimpAudienceId)) $o['MailChimpAudienceId'] = $this->MailChimpAudienceId;
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class CreateMailchimpProfile implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description  */
        // @ApiMember(Description="", IsRequired=true)
        /** @var string */
        public string $MailChimpApiKey='',

        /** @description  */
        // @ApiMember(Description="")
        /** @var string|null */
        public ?string $MailChimpAudienceId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['MailChimpApiKey'])) $this->MailChimpApiKey = $o['MailChimpApiKey'];
        if (isset($o['MailChimpAudienceId'])) $this->MailChimpAudienceId = $o['MailChimpAudienceId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->MailChimpApiKey)) $o['MailChimpApiKey'] = $this->MailChimpApiKey;
        if (isset($this->MailChimpAudienceId)) $o['MailChimpAudienceId'] = $this->MailChimpAudienceId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateMailchimpProfile DTOs

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

HTTP + XML

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

PUT /mailchimp/profile HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateMailchimpProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <MailChimpApiKey>String</MailChimpApiKey>
  <MailChimpAudienceId>String</MailChimpAudienceId>
</CreateMailchimpProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MailchimpConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MailChimpIntegration">
  <MailChimpApiKey>String</MailChimpApiKey>
  <MailChimpAudienceId>String</MailChimpAudienceId>
</MailchimpConfig>