Reservation Station API

<back to all web services

UserConfirmEmail

The following routes are available for this service:
POST/user/email/confirm
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 ApiServiceActivityRequest extends ApiServiceRequest implements IConvertible
{
    /**
    * Date that this activitiy took place. ISO 8601
    */
    // @ApiMember(Description="Date that this activitiy took place. ISO 8601", IsRequired=true)
    String? activityDate;

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

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

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

    getTypeName() => "ApiServiceActivityRequest";
    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 RatesItem implements IConvertible
{
    double? rate;
    int? minutes;

    RatesItem({this.rate,this.minutes});
    RatesItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class FacilityData implements IConvertible
{
    int? facilityId;
    String? facilityGuid;
    String? name;
    String? description;
    String? nextAvailable;
    bool? hasNextAvailable;
    List<RatesItem>? rates;
    String? themeColor;
    String? bookingNotes;
    int? leadTime;
    int? venueId;
    bool? allowExtraRequirements;

    FacilityData({this.facilityId,this.facilityGuid,this.name,this.description,this.nextAvailable,this.hasNextAvailable,this.rates,this.themeColor,this.bookingNotes,this.leadTime,this.venueId,this.allowExtraRequirements});
    FacilityData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        facilityId = json['facilityId'];
        facilityGuid = json['facilityGuid'];
        name = json['name'];
        description = json['description'];
        nextAvailable = json['nextAvailable'];
        hasNextAvailable = json['hasNextAvailable'];
        rates = JsonConverters.fromJson(json['rates'],'List<RatesItem>',context!);
        themeColor = json['themeColor'];
        bookingNotes = json['bookingNotes'];
        leadTime = json['leadTime'];
        venueId = json['venueId'];
        allowExtraRequirements = json['allowExtraRequirements'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'facilityId': facilityId,
        'facilityGuid': facilityGuid,
        'name': name,
        'description': description,
        'nextAvailable': nextAvailable,
        'hasNextAvailable': hasNextAvailable,
        'rates': JsonConverters.toJson(rates,'List<RatesItem>',context!),
        'themeColor': themeColor,
        'bookingNotes': bookingNotes,
        'leadTime': leadTime,
        'venueId': venueId,
        'allowExtraRequirements': allowExtraRequirements
    };

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

class VenueData implements IConvertible
{
    int? venueId;
    String? name;
    String? registeredDate;
    String? venueCode;
    bool? isCoordinator;
    List<FacilityData>? facilities;
    double? latitude;
    double? longitude;
    bool? hasLocation;
    String? logoUrl;
    int? leadTime;
    String? venueInfo;
    bool? allowGuests;
    String? contactNumber;

    VenueData({this.venueId,this.name,this.registeredDate,this.venueCode,this.isCoordinator,this.facilities,this.latitude,this.longitude,this.hasLocation,this.logoUrl,this.leadTime,this.venueInfo,this.allowGuests,this.contactNumber});
    VenueData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        venueId = json['venueId'];
        name = json['name'];
        registeredDate = json['registeredDate'];
        venueCode = json['venueCode'];
        isCoordinator = json['isCoordinator'];
        facilities = JsonConverters.fromJson(json['facilities'],'List<FacilityData>',context!);
        latitude = JsonConverters.toDouble(json['latitude']);
        longitude = JsonConverters.toDouble(json['longitude']);
        hasLocation = json['hasLocation'];
        logoUrl = json['logoUrl'];
        leadTime = json['leadTime'];
        venueInfo = json['venueInfo'];
        allowGuests = json['allowGuests'];
        contactNumber = json['contactNumber'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'venueId': venueId,
        'name': name,
        'registeredDate': registeredDate,
        'venueCode': venueCode,
        'isCoordinator': isCoordinator,
        'facilities': JsonConverters.toJson(facilities,'List<FacilityData>',context!),
        'latitude': latitude,
        'longitude': longitude,
        'hasLocation': hasLocation,
        'logoUrl': logoUrl,
        'leadTime': leadTime,
        'venueInfo': venueInfo,
        'allowGuests': allowGuests,
        'contactNumber': contactNumber
    };

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

class UserCustomFieldData implements IConvertible
{
    String? id;
    String? value;
    String? name;
    bool? optional;

    UserCustomFieldData({this.id,this.value,this.name,this.optional});
    UserCustomFieldData.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class VenueCustomField implements IConvertible
{
    String? venueName;
    int? venueId;
    List<UserCustomFieldData>? fields;

    VenueCustomField({this.venueName,this.venueId,this.fields});
    VenueCustomField.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        venueName = json['venueName'];
        venueId = json['venueId'];
        fields = JsonConverters.fromJson(json['fields'],'List<UserCustomFieldData>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'venueName': venueName,
        'venueId': venueId,
        'fields': JsonConverters.toJson(fields,'List<UserCustomFieldData>',context!)
    };

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

class LoginData implements IConvertible
{
    int? systemUserId;
    String? name;
    String? emailAddress;
    String? mobileNumber;
    String? refreshToken;
    String? refreshTokenExpiry;
    List<VenueData>? venues;
    List<VenueCustomField>? venueCustomFields;

    LoginData({this.systemUserId,this.name,this.emailAddress,this.mobileNumber,this.refreshToken,this.refreshTokenExpiry,this.venues,this.venueCustomFields});
    LoginData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        systemUserId = json['systemUserId'];
        name = json['name'];
        emailAddress = json['emailAddress'];
        mobileNumber = json['mobileNumber'];
        refreshToken = json['refreshToken'];
        refreshTokenExpiry = json['refreshTokenExpiry'];
        venues = JsonConverters.fromJson(json['venues'],'List<VenueData>',context!);
        venueCustomFields = JsonConverters.fromJson(json['venueCustomFields'],'List<VenueCustomField>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'systemUserId': systemUserId,
        'name': name,
        'emailAddress': emailAddress,
        'mobileNumber': mobileNumber,
        'refreshToken': refreshToken,
        'refreshTokenExpiry': refreshTokenExpiry,
        'venues': JsonConverters.toJson(venues,'List<VenueData>',context!),
        'venueCustomFields': JsonConverters.toJson(venueCustomFields,'List<VenueCustomField>',context!)
    };

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

class UserConfirmEmailResponse extends ApiServiceResponse implements IConvertible
{
    bool? registrationRequired;
    LoginData? data;

    UserConfirmEmailResponse({this.registrationRequired,this.data});
    UserConfirmEmailResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'registrationRequired': registrationRequired,
        'data': JsonConverters.toJson(data,'LoginData',context!)
    });

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

class UserConfirmEmail extends ApiServiceActivityRequest implements IConvertible
{
    int? systemUserId;
    String? code;
    int? utcOffset;

    UserConfirmEmail({this.systemUserId,this.code,this.utcOffset});
    UserConfirmEmail.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'systemUserId': systemUserId,
        'code': code,
        'utcOffset': utcOffset
    });

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

TypeContext _ctx = TypeContext(library: 'reservation.api.dev.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceActivityRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceActivityRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'RatesItem': TypeInfo(TypeOf.Class, create:() => RatesItem()),
    'FacilityData': TypeInfo(TypeOf.Class, create:() => FacilityData()),
    'List<RatesItem>': TypeInfo(TypeOf.Class, create:() => <RatesItem>[]),
    'VenueData': TypeInfo(TypeOf.Class, create:() => VenueData()),
    'List<FacilityData>': TypeInfo(TypeOf.Class, create:() => <FacilityData>[]),
    'UserCustomFieldData': TypeInfo(TypeOf.Class, create:() => UserCustomFieldData()),
    'VenueCustomField': TypeInfo(TypeOf.Class, create:() => VenueCustomField()),
    'List<UserCustomFieldData>': TypeInfo(TypeOf.Class, create:() => <UserCustomFieldData>[]),
    'LoginData': TypeInfo(TypeOf.Class, create:() => LoginData()),
    'List<VenueData>': TypeInfo(TypeOf.Class, create:() => <VenueData>[]),
    'List<VenueCustomField>': TypeInfo(TypeOf.Class, create:() => <VenueCustomField>[]),
    'UserConfirmEmailResponse': TypeInfo(TypeOf.Class, create:() => UserConfirmEmailResponse()),
    'UserConfirmEmail': TypeInfo(TypeOf.Class, create:() => UserConfirmEmail()),
});

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

POST /user/email/confirm HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"systemUserId":0,"code":"String","utcOffset":0,"activityDate":"String","apiKey":"String","latitude":0,"longitude":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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