<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 'package:servicestack/servicestack.dart';

class TestConnectionRequest implements IConvertible
{
    String? AzureServiceAdminKey;
    String? AzureSearchServiceName;

    TestConnectionRequest({this.AzureServiceAdminKey,this.AzureSearchServiceName});
    TestConnectionRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AzureServiceAdminKey = json['AzureServiceAdminKey'];
        AzureSearchServiceName = json['AzureSearchServiceName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AzureServiceAdminKey': AzureServiceAdminKey,
        'AzureSearchServiceName': AzureSearchServiceName
    };

    getTypeName() => "TestConnectionRequest";
    TypeContext? context = _ctx;
}

class TestConnectionResponse implements IConvertible
{
    bool? Result;

    TestConnectionResponse({this.Result});
    TestConnectionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Result = json['Result'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Result': Result
    };

    getTypeName() => "TestConnectionResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'www.asg.com.au', types: <String, TypeInfo> {
    'TestConnectionRequest': TypeInfo(TypeOf.Class, create:() => TestConnectionRequest()),
    'TestConnectionResponse': TypeInfo(TypeOf.Class, create:() => TestConnectionResponse()),
});

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