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 Foundation
import ServiceStack

public class CancelWaitListRequest : IRestrictedApiRequest, Codable
{
    /**
    * Api Key - Grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

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

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

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

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

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class CancelWaitListResponse : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

Swift CancelWaitListRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"String","StoreId":0,"ChainId":0,"UserId":0,"ClassScheduleId":0,"RestrictedId":0,"RestrictedResourceType":"Chain"}

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

{"Success":false,"Message":"String"}