Trendsic Platform Service

<back to all web services

GiftCardGameLeaderboardRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/GiftCardGameLeaderboard/{EndDate}/{StartDate}
<?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 GiftCardGameLeaderboard implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentId=0,
        /** @var string|null */
        public ?string $FullName=null,
        /** @var int */
        public int $Cards=0,
        /** @var int */
        public int $Points=0
    ) {
    }

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

class GiftCardGameLeaderboardResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<GiftCardGameLeaderboard>|null */
        public ?array $GiftCardGameLeaderboard=null
    ) {
    }

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

class GiftCardGameLeaderboardRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $StartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $EndDate=new DateTime()
    ) {
    }

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

PHP GiftCardGameLeaderboardRequest 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 /v1/GiftCardGameLeaderboard/{EndDate}/{StartDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
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
		}
	},
	GiftCardGameLeaderboard: 
	[
		{
			AgentId: 0,
			FullName: String,
			Cards: 0,
			Points: 0
		}
	]
}