Reservation Station API

<back to all web services

GuestSearch

Requires Authentication
The following routes are available for this service:
GET/guest/search
import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? apiKey;

    /**
    * Latitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    double? latitude;

    /**
    * Longitude of the user making this request
    */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    double? longitude;

    ApiServiceRequest({this.apiKey,this.latitude,this.longitude});
    ApiServiceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiKey = json['apiKey'];
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiKey': apiKey,
        'latitude': latitude,
        'longitude': longitude
    };

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

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    String? description;
    String? heading;
    bool? wasSuccessful;
    dynamic? modelState;

    ApiServiceResponse({this.description,this.heading,this.wasSuccessful,this.modelState});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        description = json['description'];
        heading = json['heading'];
        wasSuccessful = json['wasSuccessful'];
        modelState = JsonConverters.fromJson(json['modelState'],'dynamic',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'description': description,
        'heading': heading,
        'wasSuccessful': wasSuccessful,
        'modelState': JsonConverters.toJson(modelState,'dynamic',context!)
    };

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

class GuestSearchResultItem implements IConvertible
{
    int? id;
    String? name;
    String? email;
    String? mobileNumber;

    GuestSearchResultItem({this.id,this.name,this.email,this.mobileNumber});
    GuestSearchResultItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        name = json['name'];
        email = json['email'];
        mobileNumber = json['mobileNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'email': email,
        'mobileNumber': mobileNumber
    };

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

class GuestSearchResponse extends ApiServiceResponse implements IConvertible
{
    List<GuestSearchResultItem>? userResults;

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

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        userResults = JsonConverters.fromJson(json['userResults'],'List<GuestSearchResultItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'userResults': JsonConverters.toJson(userResults,'List<GuestSearchResultItem>',context!)
    });

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

class GuestSearch extends ApiServiceRequest implements IConvertible
{
    int? venueId;
    String? searchQuery;

    GuestSearch({this.venueId,this.searchQuery});
    GuestSearch.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        venueId = json['venueId'];
        searchQuery = json['searchQuery'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'venueId': venueId,
        'searchQuery': searchQuery
    });

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

TypeContext _ctx = TypeContext(library: 'reservation.api.dev.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'GuestSearchResultItem': TypeInfo(TypeOf.Class, create:() => GuestSearchResultItem()),
    'GuestSearchResponse': TypeInfo(TypeOf.Class, create:() => GuestSearchResponse()),
    'List<GuestSearchResultItem>': TypeInfo(TypeOf.Class, create:() => <GuestSearchResultItem>[]),
    'GuestSearch': TypeInfo(TypeOf.Class, create:() => GuestSearch()),
});

Dart GuestSearch DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /guest/search HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}