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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetSalesPackagesRequest extends GetSalesPackagesRequestDto 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 String ApiKey = null;

        /**
        * 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 Integer StoreId = null;

        /**
        * 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 Integer UserId = null;

        /**
        * 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 Integer CreditFilterType = null;

        /**
        * 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 Integer CreditFilterId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        /**
        * 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 Boolean InApp = null;
        
        public String getApiKey() { return ApiKey; }
        public GetSalesPackagesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetSalesPackagesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public GetSalesPackagesRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getCreditFilterType() { return CreditFilterType; }
        public GetSalesPackagesRequest setCreditFilterType(Integer value) { this.CreditFilterType = value; return this; }
        public Integer getCreditFilterId() { return CreditFilterId; }
        public GetSalesPackagesRequest setCreditFilterId(Integer value) { this.CreditFilterId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetSalesPackagesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetSalesPackagesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
        public Boolean isInApp() { return InApp; }
        public GetSalesPackagesRequest setInApp(Boolean value) { this.InApp = value; return this; }
    }

    public static class GetSalesPackagesRequestDto extends ApiDtoBase
    {
        
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java GetSalesPackagesRequest 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 /sales/packages HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv