ClubReady Api

<back to all web services

BookingStatusUpdateRequest

The following routes are available for this service:
POST/scheduling/booking-status-updateUpdate a Booking Status

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

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

export class BookingStatusUpdateRequestDto extends ApiDtoBase
{
    public UserId?: number;
    public StatusId: number;
    public BookingId: number;

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

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class BookingStatusUpdateRequest extends BookingStatusUpdateRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * StoreId
    */
    // @ApiMember(DataType="string", Description="StoreId", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * UserID
    */
    // @ApiMember(DataType="string", Description="UserID", IsRequired=true, Name="UserId", ParameterType="query")
    public UserId: number;

    /**
    * Status ID
    */
    // @ApiMember(DataType="integer", Description="Status ID", IsRequired=true, Name="StatusId", ParameterType="query")
    public StatusId: number;

    /**
    * Booking ID
    */
    // @ApiMember(DataType="integer", Description="Booking ID", IsRequired=true, Name="BookingId", ParameterType="query")
    public BookingId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

export class BookingStatusUpdateResponseDto
{
    public Success: boolean;
    public Message: string;

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

export class BookingStatusUpdateResponse extends BookingStatusUpdateResponseDto
{
    public Success: boolean;
    public Message: string;

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

TypeScript BookingStatusUpdateRequest DTOs

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

HTTP + XML

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

POST /scheduling/booking-status-update HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BookingStatusUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <BookingId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">0</BookingId>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">0</StatusId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Requests">0</UserId>
</BookingStatusUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BookingStatusUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Responses">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Scheduling.Models.Dto.Responses">false</Success>
</BookingStatusUpdateResponse>