BokaMera.API.Host

<back to all web services

SubscribeToNewsletter

<?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 SubscribedUserResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Subscribed=null,
        /** @var string */
        public string $CompanyId=''
    ) {
    }

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class SubscribeToNewsletter 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 Companies for which user is subscribed. */
        // @ApiMember(Description="Companies for which user is subscribed.", IsRequired=true)
        /** @var array<SubscribedUserResponse>|null */
        public ?array $SubscribedCompanies=null
    ) {
    }

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

PHP SubscribeToNewsletter DTOs

PUT /newsletter/subscribe HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	SubscribedCompanies: 
	[
		{
			Subscribed: False
		}
	]
}

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

[
	{
		Subscribed: False
	}
]