sfgboxapi

<back to all web services

UsersGroupsAdd

Requires Authentication
The following routes are available for this service:
POST/users_groups
<?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 UsersGroupsAddResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $name=null,

        // @DataMember(Order=5)
        /** @var bool|null */
        public ?bool $isPaid=null,

        // @DataMember(Order=7)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantsId'])) $this->tenantsId = $o['tenantsId'];
        if (isset($o['appUserId'])) $this->appUserId = $o['appUserId'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['isPaid'])) $this->isPaid = $o['isPaid'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantsId)) $o['tenantsId'] = $this->tenantsId;
        if (isset($this->appUserId)) $o['appUserId'] = $this->appUserId;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->isPaid)) $o['isPaid'] = $this->isPaid;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class UsersGroupsAdd implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $tenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $appUserId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $name='',

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var bool|null */
        public ?bool $isPaid=null
    ) {
    }

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

PHP UsersGroupsAdd 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 /users_groups HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"appUserId":0,"name":"String","isPaid":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"appUserId":0,"name":"String","isPaid":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}