BWUKNewsletterSignup

<back to all web services

BWEmailSignupRequest

Requires Authentication
The following routes are available for this service:
POST/1.0/BWEmailSignupRequestPass the email sign up requests for updating CRM
<?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 BWEmailSignupResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Result=null
    ) {
    }

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

class BWEmailSignupRequest implements JsonSerializable
{
    public function __construct(
        /** @description Customer Surname */
        // @ApiMember(Description="Customer Surname")
        /** @var string|null */
        public ?string $surname=null,

        /** @description Customer Forename */
        // @ApiMember(Description="Customer Forename")
        /** @var string|null */
        public ?string $forename=null,

        /** @description Customer Email Address */
        // @ApiMember(Description="Customer Email Address")
        /** @var string|null */
        public ?string $emailAddress=null
    ) {
    }

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

PHP BWEmailSignupRequest 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.

POST /1.0/BWEmailSignupRequest HTTP/1.1 
Host: bwuknewsletterws-uat.rapp-customers.co.uk 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"surname":"String","forename":"String","emailAddress":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Result":"String"}