Reservation Station API

<back to all web services

GetFacilitySchedule

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 enum SlotStatus
{
    Available = 0,
    Closed = 1,
    Booked = 2,
    UserBooked = 3,
    GroupBooked = 4,
    ToBook = 5,
}

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 SlotData
{
    public start: string;
    public end: string;
    public status: SlotStatus;
    public bookingId: number;
    public remindStart: boolean;
    public remind30Mins: boolean;
    public remind1Hour: boolean;
    public remind6Hours: boolean;
    public remind12Hours: boolean;
    public remind1Day: boolean;
    public remind1Week: boolean;
    public billableAmount: number;
    public bookedByName: string;
    public billableHours: number;
    public slotLength: number;
    public userData: GuestData;
    public extraRequirements: string;

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

export class ScheduleDayData
{
    public date: string;
    public slots: SlotData[];

    public constructor(init?: Partial<ScheduleDayData>) { (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 GetFacilityScheduleResponse extends ApiServiceResponse
{
    public schedule: ScheduleDayData[];
    public bookAheadMaxDate: string;
    public openHour: number;
    public closeHour: number;
    public duration: number;
    public isCoordinator: boolean;
    public facilityTimeOffset: number;
    public facility: FacilityData;
    public venueName: string;
    public allowGuests: boolean;
    public allowExtraRequirements: boolean;
    public allowBookingInProgress: boolean;

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

export class GetFacilitySchedule extends ApiServiceRequest
{
    public facilityId: number;
    public start: string;
    public end: string;

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

TypeScript GetFacilitySchedule DTOs

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

{
	facilityId: 0,
	start: 0001-01-01,
	end: 0001-01-01,
	apiKey: String,
	latitude: 0,
	longitude: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	schedule: 
	[
		{
			date: String,
			slots: 
			[
				{
					start: String,
					end: String,
					status: 0,
					bookingId: 0,
					remindStart: False,
					remind30Mins: False,
					remind1Hour: False,
					remind6Hours: False,
					remind12Hours: False,
					remind1Day: False,
					remind1Week: False,
					billableAmount: 0,
					bookedByName: String,
					billableHours: 0,
					slotLength: 0,
					extraRequirements: String
				}
			]
		}
	],
	bookAheadMaxDate: String,
	openHour: 0,
	closeHour: 0,
	duration: 0,
	isCoordinator: False,
	facilityTimeOffset: 0,
	venueName: String,
	allowGuests: False,
	allowExtraRequirements: False,
	allowBookingInProgress: False,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}