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

export class ApiDtoBase
{
    public ApiKey: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetClubsListRequestDto extends ApiDtoBase
{

    public constructor(init?: Partial<GetClubsListRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class GetClubsListRequest extends GetClubsListRequestDto implements IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * Corporate Chain ID.
    */
    // @ApiMember(DataType="integer", Description="Corporate Chain ID.", IsRequired=true, Name="ChainId", ParameterType="query")
    public ChainId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetClubsListRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: www.clubready.com 
Accept: application/xml