<back to all web services

PageKeyRequest

The following routes are available for this service:
GET/RestApi/markup/keys/{StrategyKey}
<?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 PageKeyRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $StrategyKey=null
    ) {
    }

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

class TemplateKeyResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<string>|null */
        public ?array $Keys=null
    ) {
    }

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

PHP PageKeyRequest DTOs

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

HTTP + CSV

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

GET /RestApi/markup/keys/{StrategyKey} HTTP/1.1 
Host: www.asg.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'TemplateKeyResponse' using the custom 'csv' filter}No parameterless constructor defined for this object.