ClubReady Api

<back to all web services

GetSalesPackagesRequest

The following routes are available for this service:
GET/sales/packagesGet Available packages for a chain or store

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

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

export class GetSalesPackagesRequestDto extends ApiDtoBase
{

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

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

export class GetSalesPackagesRequest extends GetSalesPackagesRequestDto implements IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * 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;

    /**
    * ID # of store to get packages for
    */
    // @ApiMember(DataType="string", Description="ID # of store to get packages for", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * ID # of the user to get packages for
    */
    // @ApiMember(DataType="integer", Description="ID # of the user to get packages for", Name="UserId", ParameterType="query")
    public UserId?: number;

    /**
    * The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)
    */
    // @ApiMember(DataType="integer", Description="The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)", Name="CreditFilterType", ParameterType="query")
    public CreditFilterType?: number;

    /**
    * ClassId or ClassScheduleId or SessionSizeId packages which drop credits
    */
    // @ApiMember(DataType="integer", Description="ClassId or ClassScheduleId or SessionSizeId packages which drop credits", Name="CreditFilterId", ParameterType="query")
    public CreditFilterId?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;
    /**
    * Show packages enabled for In App purchase. True or False
    */
    // @ApiMember(DataType="string", Description="Show packages enabled for In App purchase. True or False", Name="InApp", ParameterType="query")
    public InApp: boolean;

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

TypeScript GetSalesPackagesRequest 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 /sales/packages HTTP/1.1 
Host: clubready.com 
Accept: application/json