Reservation Station API

<back to all web services

UserSearch

Requires Authentication
The following routes are available for this service:
GET/user/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 UserSearchResultItem implements IConvertible
{
    int? id;
    String? name;
    String? email;

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

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

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

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

class UserSearchResponse extends ApiServiceResponse implements IConvertible
{
    List<UserSearchResultItem>? userResults;

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

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

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

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

class UserSearch extends ApiServiceRequest implements IConvertible
{
    int? facilityId;
    String? searchQuery;

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

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

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

    getTypeName() => "UserSearch";
    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()),
    'UserSearchResultItem': TypeInfo(TypeOf.Class, create:() => UserSearchResultItem()),
    'UserSearchResponse': TypeInfo(TypeOf.Class, create:() => UserSearchResponse()),
    'List<UserSearchResultItem>': TypeInfo(TypeOf.Class, create:() => <UserSearchResultItem>[]),
    'UserSearch': TypeInfo(TypeOf.Class, create:() => UserSearch()),
});

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

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

<UserSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">String</Heading>
  <ModelState xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base" />
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base">false</WasSuccessful>
  <UserResults i:nil="true" />
</UserSearchResponse>