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.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CancelWaitListRequest 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 String ApiKey = null;

        /**
        * Store ID or Chain ID is required
        */
        @ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * Store ID or Chain ID is required
        */
        @ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * ClubReady User ID
        */
        @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
        public Integer UserId = null;

        /**
        * Class Schedule ID
        */
        @ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")
        public Integer ClassScheduleId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CancelWaitListRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CancelWaitListRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public CancelWaitListRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getUserId() { return UserId; }
        public CancelWaitListRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getClassScheduleId() { return ClassScheduleId; }
        public CancelWaitListRequest setClassScheduleId(Integer value) { this.ClassScheduleId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CancelWaitListRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CancelWaitListRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class CancelWaitListResponse
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public CancelWaitListResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public CancelWaitListResponse setMessage(String value) { this.Message = value; return this; }
    }

}

Java 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: 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>