Reservation Station API

<back to all web services

CheckVenue

Requires Authentication
The following routes are available for this service:
GET/venue/check
GET/venue/check/{venuecode}
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 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 CheckVenueResponse extends ApiServiceResponse implements IConvertible
{
    int? venueId;
    String? name;
    List<UserCustomFieldData>? customFields;

    CheckVenueResponse({this.venueId,this.name,this.customFields});
    CheckVenueResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'venueId': venueId,
        'name': name,
        'customFields': JsonConverters.toJson(customFields,'List<UserCustomFieldData>',context!)
    });

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

class CheckVenue extends ApiServiceRequest implements IConvertible
{
    String? venueCode;

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

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

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

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

Dart CheckVenue 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 /venue/check HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CheckVenueResponse 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>
  <CustomFields>
    <UserCustomFieldData>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Name>String</Name>
      <Optional>false</Optional>
      <Value>String</Value>
    </UserCustomFieldData>
  </CustomFields>
  <Name>String</Name>
  <VenueId>0</VenueId>
</CheckVenueResponse>