digitaluapi

<back to all web services

GetTestUsers

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: duengageapi.uat.scadsoftware.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
	]
}