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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Scheduling.Model
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Scheduling.Model

        Public Partial Class CancelWaitListRequest
            Implements IRestrictedApiRequest
            '''<Summary>
            '''IP address of the end user
            '''</Summary>
            <ApiMember(Description:="IP address of the end user", Name:="X-Forwarded-For", ParameterType:="header")>
            Public Overridable Property XForwardedFor As String

            '''<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 Overridable Property ApiKey As String

            '''<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 Overridable Property StoreId As Nullable(Of Integer)

            '''<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 Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''ClubReady User ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady User ID", IsRequired:=true, Name:="UserId", ParameterType:="path")>
            Public Overridable Property UserId As Integer

            '''<Summary>
            '''Class Schedule ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Class Schedule ID", IsRequired:=true, Name:="ClassScheduleId", ParameterType:="query")>
            Public Overridable Property ClassScheduleId As Integer

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class

        Public Partial Class CancelWaitListResponse
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET 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>