ClubReady Api

<back to all web services

CancelWaitListRequest

The following routes are available for this service:
POST/scheduling/{UserId}/cancel-wait-listCancel a wait list record.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Scheduling.Model;
using ClubReady.Web.Api;

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Scheduling.Model
{
    public partial class CancelWaitListRequest
        : IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - Grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Store ID or Chain ID is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///Store ID or Chain ID is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")]
        public virtual int UserId { get; set; }

        ///<summary>
        ///Class Schedule ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")]
        public virtual int ClassScheduleId { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class CancelWaitListResponse
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

}

C# CancelWaitListRequest 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/{UserId}/cancel-wait-list HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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