Reservation Station API

<back to all web services

CheckGuest

Requires Authentication
"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 CheckGuestResponse extends ApiServiceResponse {
    /** @param {{alreadyUser?:boolean,systemUserId?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    alreadyUser;
    /** @type {number} */
    systemUserId;
}
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 GuestData {
    /** @param {{name?:string,emailAddress?:string,mobileNumber?:string,userCustomFields?:UserCustomFieldData[],isAlreadyUser?:boolean,systemUserId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {string} */
    emailAddress;
    /** @type {string} */
    mobileNumber;
    /** @type {UserCustomFieldData[]} */
    userCustomFields;
    /** @type {boolean} */
    isAlreadyUser;
    /** @type {number} */
    systemUserId;
}
export class CheckGuest extends ApiServiceRequest {
    /** @param {{guestData?:GuestData,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {GuestData} */
    guestData;
}

JavaScript CheckGuest 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 /json/reply/CheckGuest HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"alreadyUser":false,"systemUserId":0,"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}