<back to all web services

TestConnectionRequest

The following routes are available for this service:
All Verbs/RestApi/search/testConnection
All Verbs/RestApi/search/testConnection
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestConnectionRequest:
    azure_service_admin_key: Optional[str] = None
    azure_search_service_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestConnectionResponse:
    result: bool = False

Python 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>