ClubReady Api

GetProspectTypesRequest

The following routes are available for this service:
GET	/club/lead-types	List of prospect types.


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

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

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

export class GetProspectTypesRequest extends ApiDtoBase 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;

    /**
    * Either StoreId or ChainId is required
    */
    // @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * Either StoreId or ChainId is required
    */
    // @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

export class ApiGenericType
{
    public Id: number;
    public Name: string;
    public StoreId?: number;
    public ChainId?: number;

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

export class GetProspectTypesResponseDto
{
    public LeadTypes: ApiGenericType[];

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

export class GetProspectTypesResponse extends GetProspectTypesResponseDto
{
    public LeadTypes: ApiGenericType[];

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

TypeScript GetProspectTypesRequest 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 /club/lead-types HTTP/1.1 
Host: clubready.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"LeadTypes":[{"Id":0,"Name":"String","StoreId":0,"ChainId":0}]}