ClubReady Api

GetClubsListRequest

The following routes are available for this service:
GET	/v2/{ApiKey}/corp/{ChainId}/clubs	Get Clubs	Get a list of all clubs by ChainID
GET	/corp/{chainId}/clubs	Get Clubs	Get a list of all clubs by ChainID

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetClubsListRequest : GetClubsListRequestDto(), 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

    /**
    * Corporate Chain ID.
    */
    @ApiMember(DataType="integer", Description="Corporate Chain ID.", IsRequired=true, Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

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

open class GetClubsListRequestDto : ApiDtoBase()
{
}

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

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

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

GET /v2/{ApiKey}/corp/{ChainId}/clubs HTTP/1.1 
Host: clubready.com 
Accept: application/xml