Reservation Station API

<back to all web services

GetGroup

Requires Authentication
The following routes are available for this service:
GET/group/
GET/group/{VenueId}
"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 GroupUserData {
    /** @param {{id?:number,userId?:number,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {number} */
    userId;
    /** @type {string} */
    name;
}
export class GroupData {
    /** @param {{id?:number,name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    name;
}
export class GetGroupResponse extends ApiServiceResponse {
    /** @param {{groupCode?:string,groupUsers?:GroupUserData[],myGroups?:GroupData[],venueName?:string,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    groupCode;
    /** @type {GroupUserData[]} */
    groupUsers;
    /** @type {GroupData[]} */
    myGroups;
    /** @type {string} */
    venueName;
}
export class GetGroup extends ApiServiceRequest {
    /** @param {{venueId?:number,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    venueId;
}

JavaScript GetGroup DTOs

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

HTTP + CSV

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

GET /group/ HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"groupCode":"String","groupUsers":[{}],"myGroups":[{}],"venueName":"String","description":"String","heading":"String","wasSuccessful":false,"modelState":{}}