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.
namespace ClubReady.Web.Api

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type CancelWaitListRequest() = 
        ///<summary>
        ///IP address of the end user
        ///</summary>
        [<ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")>]
        member val XForwardedFor:String = null with get,set

        ///<summary>
        ///Api Key - Grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - Grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with 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")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with 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")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///Class Schedule ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")>]
        member val ClassScheduleId:Int32 = new Int32() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type CancelWaitListResponse() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

F# 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>