<back to all web services

TestConnectionRequest

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

export class TestConnectionRequest
{
    public AzureServiceAdminKey: string;
    public AzureSearchServiceName: string;

    public constructor(init?: Partial<TestConnectionRequest>) { (Object as any).assign(this, init); }
}

export class TestConnectionResponse
{
    public Result: boolean;

    public constructor(init?: Partial<TestConnectionResponse>) { (Object as any).assign(this, init); }
}

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