ClubReady Api

<back to all web services

UserOnlineCancelRequest

The following routes are available for this service:
GET/users/{UserId}/online-cancelGet an online cancellation link for a user
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UserOnlineCancelRequest : UserOnlineCancelRequestDto(), IRestrictedApiRequest
{
    /**
    * 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

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

    /**
    * StoreId of the user's home club
    */
    @ApiMember(DataType="integer", Description="StoreId of the user's home club", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * 
    */
    @ApiMember(DataType="integer", Description="", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

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

open class UserOnlineCancelRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

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

Kotlin UserOnlineCancelRequest 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.

GET /users/{UserId}/online-cancel HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'Uri' using the custom 'csv' filter}No parameterless constructor defined for this object.