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}
"use strict";
export class ApiServiceRequest {
    /** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    apiKey;
    /**
     * @type {number}
     * @description Latitude of the user making this request */
    latitude;
    /**
     * @type {number}
     * @description Longitude of the user making this request */
    longitude;
}
export class ApiServiceResponse {
    /** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    description;
    /** @type {string} */
    heading;
    /** @type {boolean} */
    wasSuccessful;
    /** @type {Object} */
    modelState;
}
export class UserCustomFieldData {
    /** @param {{id?:string,value?:string,name?:string,optional?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    value;
    /** @type {string} */
    name;
    /** @type {boolean} */
    optional;
}
export class CheckVenueResponse extends ApiServiceResponse {
    /** @param {{venueId?:number,name?:string,customFields?:UserCustomFieldData[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    venueId;
    /** @type {string} */
    name;
    /** @type {UserCustomFieldData[]} */
    customFields;
}
export class CheckVenue extends ApiServiceRequest {
    /** @param {{venueCode?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    venueCode;
}

JavaScript CheckVenue DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	venueId: 0,
	name: String,
	customFields: 
	[
		{
			id: 00000000-0000-0000-0000-000000000000,
			value: String,
			name: String,
			optional: False
		}
	],
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}