Reservation Station API

<back to all web services

GetFacilityStatus

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 FacilityStatusData {
    /** @param {{facilityName?:string,themeColor?:string,venueLogoUrl?:string,inProgress?:boolean,currentReservationName?:string,currentReservationStart?:string,currentReservationEnd?:string,currentReservationId?:number,hasNextReservation?:boolean,nextReservationName?:string,nextReservationStart?:string,nextReservationEnd?:string,nextReservationId?:number,freeUntilNextBooking?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    facilityName;
    /** @type {string} */
    themeColor;
    /** @type {string} */
    venueLogoUrl;
    /** @type {boolean} */
    inProgress;
    /** @type {string} */
    currentReservationName;
    /** @type {string} */
    currentReservationStart;
    /** @type {string} */
    currentReservationEnd;
    /** @type {number} */
    currentReservationId;
    /** @type {boolean} */
    hasNextReservation;
    /** @type {string} */
    nextReservationName;
    /** @type {string} */
    nextReservationStart;
    /** @type {string} */
    nextReservationEnd;
    /** @type {number} */
    nextReservationId;
    /** @type {boolean} */
    freeUntilNextBooking;
}
export class RatesItem {
    /** @param {{rate?:number,minutes?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    rate;
    /** @type {number} */
    minutes;
}
export class FacilityData {
    /** @param {{facilityId?:number,facilityGuid?:string,name?:string,description?:string,nextAvailable?:string,hasNextAvailable?:boolean,rates?:RatesItem[],themeColor?:string,bookingNotes?:string,leadTime?:number,venueId?:number,allowExtraRequirements?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    facilityId;
    /** @type {string} */
    facilityGuid;
    /** @type {string} */
    name;
    /** @type {string} */
    description;
    /** @type {string} */
    nextAvailable;
    /** @type {boolean} */
    hasNextAvailable;
    /** @type {RatesItem[]} */
    rates;
    /** @type {string} */
    themeColor;
    /** @type {string} */
    bookingNotes;
    /** @type {number} */
    leadTime;
    /** @type {number} */
    venueId;
    /** @type {boolean} */
    allowExtraRequirements;
}
export class GetFacilityStatusResponse extends ApiServiceResponse {
    /** @param {{facilityStatus?:FacilityStatusData,facilityData?:FacilityData,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {FacilityStatusData} */
    facilityStatus;
    /** @type {FacilityData} */
    facilityData;
}
export class GetFacilityStatus extends ApiServiceRequest {
    /** @param {{facilityGuid?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    facilityGuid;
}

JavaScript GetFacilityStatus DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsonl/reply/GetFacilityStatus HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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