TestConnectionRequest

The following routes are available for this service:
All Verbs	/RestApi/search/testConnection
All Verbs	/RestApi/search/testConnection

<?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 TestConnectionRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $AzureServiceAdminKey=null,
        /** @var string|null */
        public ?string $AzureSearchServiceName=null
    ) {
    }

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

class TestConnectionResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Result=null
    ) {
    }

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

PHP TestConnectionRequest DTOs

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

HTTP + XML

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

POST /RestApi/search/testConnection HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestConnectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <AzureSearchServiceName>String</AzureSearchServiceName>
  <AzureServiceAdminKey>String</AzureServiceAdminKey>
</TestConnectionRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TestConnectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <Result>false</Result>
</TestConnectionResponse>