Reservation Station API

<back to all web services

JoinVenue

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 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 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 VenueCustomField
{
    public venueName: string;
    public venueId: number;
    public fields: UserCustomFieldData[];

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

export class JoinVenueResponse extends ApiServiceResponse
{
    public venues: VenueData[];
    public venueCustomFields: VenueCustomField[];

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

export class JoinVenue extends ApiServiceRequest
{
    public venueCode: string;
    public userCustomFields: UserCustomFieldData[];

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

TypeScript JoinVenue DTOs

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

{"venueCode":"String","userCustomFields":[{"id":"00000000-0000-0000-0000-000000000000","value":"String","name":"String","optional":false}],"apiKey":"String","latitude":0,"longitude":0}

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

{"venues":[{}],"venueCustomFields":[{"venueName":"String","venueId":0,"fields":[{"id":"00000000-0000-0000-0000-000000000000","value":"String","name":"String","optional":false}]}],"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}