Test

<back to all web services

GetExample

The following routes are available for this service:
GET/example
<?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 MenuItemExampleItem implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @ApiMember()
        /** @var string|null */
        public ?string $name1=null
    ) {
    }

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

class MenuItemExample implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @ApiMember()
        /** @var string|null */
        public ?string $name1=null,

        /** @var MenuItemExampleItem|null */
        public ?MenuItemExampleItem $menuItemExampleItem=null
    ) {
    }

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

// @DataContract
class MenuExample implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @ApiMember()
        /** @var MenuItemExample|null */
        public ?MenuItemExample $menuItemExample1=null
    ) {
    }

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

// @DataContract
class GetExampleResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,

        // @DataMember(Order=2)
        // @ApiMember()
        /** @var MenuExample|null */
        public ?MenuExample $menuExample1=null
    ) {
    }

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

// @DataContract
class GetExample implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /example HTTP/1.1 
Host: test.servicestack.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	menuExample1: 
	{
		menuItemExample1: 
		{
			name1: String,
			menuItemExampleItem: 
			{
				name1: String
			}
		}
	}
}