<back to all web services

SuggestionsRequest

<?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 SuggestionsRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $IndexName=null,
        /** @var string|null */
        public ?string $SuggestionFields=null,
        /** @var string|null */
        public ?string $Text=null,
        /** @var string|null */
        public ?string $Language=null,
        /** @var string|null */
        public ?string $SiteId=null,
        /** @var string|null */
        public ?string $ScoringInfo=null,
        /** @var bool|null */
        public ?bool $ResultsForAllSites=null
    ) {
    }

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

class SuggestionsResponse implements JsonSerializable
{
    public function __construct(
        /** @var string[]|null */
        public ?array $Suggestions=null
    ) {
    }

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

PHP SuggestionsRequest DTOs

POST /RestApi/search/suggestions HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IndexName: String,
	SuggestionFields: String,
	Text: String,
	Language: String,
	SiteId: String,
	ScoringInfo: String,
	ResultsForAllSites: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Suggestions: 
	[
		String
	]
}