ClubReady Api

<back to all web services

GetSalesPackageDiscountsRequest

The following routes are available for this service:
GET/sales/packages/{PackageId}/installmentsGet sales package installments

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 GetSalesPackageInstallmentsDto extends ApiDtoBase
{
    public PackageId: number;

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

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

export class GetSalesPackageDiscountsRequest extends GetSalesPackageInstallmentsDto 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;

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

    /**
    * ID # of package to get installment plans for
    */
    // @ApiMember(DataType="string", Description="ID # of package to get installment plans for", IsRequired=true, Name="PackageId", ParameterType="path")
    public PackageId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

TypeScript GetSalesPackageDiscountsRequest 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/{PackageId}/installments HTTP/1.1 
Host: clubready.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"Id":0,"ForOnlineSale":false,"PaymentCount":0,"DuePerPayment":"String","Fees":[{"Name":"String","Amount":"String","Taxable":false,"CanBeWaived":false,"CanDuplicate":false,"OneTime":false,"DueUpfront":false,"PayFrequencyMonths":0}]}]