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.*


open class CancelWaitListRequest : IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * Api Key - Grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * Store ID or Chain ID is required
    */
    @ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * Store ID or Chain ID is required
    */
    @ApiMember(DataType="integer", Description="Store ID or Chain ID is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * ClubReady User ID
    */
    @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
    var UserId:Int? = null

    /**
    * Class Schedule ID
    */
    @ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")
    var ClassScheduleId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class CancelWaitListResponse
{
    var Success:Boolean? = null
    var Message:String? = null
}

Kotlin 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>
  <XForwardedFor>String</XForwardedFor>
</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>