Reservation Station API

<back to all web services

GetVenueReservations

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 UserCustomFieldData
{
    public id: string;
    public value: string;
    public name: string;
    public optional: boolean;

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

export class GuestData
{
    public name: string;
    public emailAddress: string;
    public mobileNumber: string;
    public userCustomFields: UserCustomFieldData[];
    public isAlreadyUser: boolean;
    public systemUserId: number;

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

export class VenueReservationData implements IBookingData
{
    public dayEnd: number;
    public dayStart: number;
    public bookingId: number;
    public slotLength: number;
    public facilityId: number;
    public facilityTimeOffset: number;
    public cancellationLeadTime: number;
    public end: string;
    public start: string;
    public userName: string;
    public facilityName: string;
    public facilityColour: string;
    public reservationStatus: string;
    public finished: boolean;
    public billableHours: number;
    public billedAmount: number;
    public userData: GuestData;
    public allowExtraRequirements: boolean;
    public extraRequirements: string;

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

export class GetVenueReservationsResponse extends ApiServiceResponse
{
    public reservations: VenueReservationData[];

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

export class GetVenueReservations extends ApiServiceRequest
{
    public venueId: number;

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

TypeScript GetVenueReservations 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.

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

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

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