ClubReady Api

<back to all web services

GetClubsListRequest

The following routes are available for this service:
GET/v2/{ApiKey}/corp/{ChainId}/clubsGet ClubsGet a list of all clubs by ChainID
GET/corp/{chainId}/clubsGet ClubsGet a list of all clubs by ChainID
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Corporate.Model
Imports ClubReady.Core.Clubs.Models.ApiDto
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace ClubReady.Core.Clubs.Models.ApiDto

        Public Partial Class GetClubsListRequestDto
            Inherits ApiDtoBase
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Corporate.Model

        Public Partial Class GetClubsListRequest
            Inherits GetClubsListRequestDto
            Implements IRestrictedApiRequest
            '''<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>
            '''Corporate Chain ID.
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Corporate Chain ID.", IsRequired:=true, Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

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

VB.NET GetClubsListRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json