sfgboxapi

<back to all web services

GetTestUsers

Requires Authentication
The following routes are available for this service:
All Verbs/test/users
All Verbs/test/users/{role}
<?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 TestUsersResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $email=null,
        /** @var string[]|null */
        public ?array $roles=null
    ) {
    }

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

class GetTestUsers implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $role=null
    ) {
    }

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

PHP GetTestUsers DTOs

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

HTTP + JSV

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

POST /test/users HTTP/1.1 
Host: api.sfgtec.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	role: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	email: String,
	roles: 
	[
		String
	]
}