BokaMera.API.Host

<back to all web services

PaysonApiSettingsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/payment/payson/apisettingsGet payson api settingsGet payson api settings for the logged in company
<?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 PaysonApiSettingsQueryResponse implements JsonSerializable
{
    public function __construct(
        /** @description The company id */
        // @ApiMember(Description="The company id")
        /** @var string */
        public string $CompanyId='',

        /** @description The payson security user id */
        // @ApiMember(Description="The payson security user id")
        /** @var string|null */
        public ?string $SecurityUserId=null,

        /** @description The payson security user password */
        // @ApiMember(Description="The payson security user password")
        /** @var string|null */
        public ?string $SecurityPassword=null,

        /** @description The payson receiver email */
        // @ApiMember(Description="The payson receiver email")
        /** @var string|null */
        public ?string $ReceiverEmail=null,

        /** @description The payson receiver firstname */
        // @ApiMember(Description="The payson receiver firstname")
        /** @var string|null */
        public ?string $ReceiverFirstname=null,

        /** @description The payson receiver lastname */
        // @ApiMember(Description="The payson receiver lastname")
        /** @var string|null */
        public ?string $ReceiverLastname=null
    ) {
    }

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

// @ValidateRequest(Validator="IsAuthenticated")
class PaysonApiSettingsQuery 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
    ) {
    }

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

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

GET /payment/payson/apisettings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"SecurityUserId":"String","SecurityPassword":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}