Reservation Station API

<back to all web services

GetDashboardInfo

Requires Authentication

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    public description: string;
    public heading: string;
    public wasSuccessful: boolean;
    public modelState: Object;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class DashBookingInfo
{
    public bookingId: number;
    public start: string;
    public end: string;
    public facilityName: string;
    public venueName: string;

    public constructor(init?: Partial<DashBookingInfo>) { (Object as any).assign(this, init); }
}

export class RatesItem
{
    public rate: number;
    public minutes: number;

    public constructor(init?: Partial<RatesItem>) { (Object as any).assign(this, init); }
}

export class FacilityData
{
    public facilityId: number;
    public facilityGuid: string;
    public name: string;
    public description: string;
    public nextAvailable: string;
    public hasNextAvailable: boolean;
    public rates: RatesItem[];
    public themeColor: string;
    public bookingNotes: string;
    public leadTime: number;
    public venueId: number;
    public allowExtraRequirements: boolean;

    public constructor(init?: Partial<FacilityData>) { (Object as any).assign(this, init); }
}

export class VenueData
{
    public venueId: number;
    public name: string;
    public registeredDate: string;
    public venueCode: string;
    public isCoordinator: boolean;
    public facilities: FacilityData[];
    public latitude: number;
    public longitude: number;
    public hasLocation: boolean;
    public logoUrl: string;
    public leadTime: number;
    public venueInfo: string;
    public allowGuests: boolean;
    public contactNumber: string;

    public constructor(init?: Partial<VenueData>) { (Object as any).assign(this, init); }
}

export class GetDashboardInfoResponse extends ApiServiceResponse
{
    public bookings: DashBookingInfo[];
    public venues: VenueData[];

    public constructor(init?: Partial<GetDashboardInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetDashboardInfo extends ApiServiceRequest
{

    public constructor(init?: Partial<GetDashboardInfo>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetDashboardInfo 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/GetDashboardInfo 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

{"bookings":[{}],"venues":[{}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}