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
namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type GetSalesPackagesRequestDto() = 
        inherit ApiDtoBase()

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type GetSalesPackagesRequest() = 
        inherit GetSalesPackagesRequestDto()
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///ID # of store to get packages for
        ///</summary>
        [<ApiMember(DataType="string", Description="ID # of store to get packages for", IsRequired=true, Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ID # of the user to get packages for
        ///</summary>
        [<ApiMember(DataType="integer", Description="ID # of the user to get packages for", Name="UserId", ParameterType="query")>]
        member val UserId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)
        ///</summary>
        [<ApiMember(DataType="integer", Description="The filter type which will used for packages credit (Class = 1, ClassSchedule = 2, SessionSize = 3)", Name="CreditFilterType", ParameterType="query")>]
        member val CreditFilterType:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ClassId or ClassScheduleId or SessionSizeId packages which drop credits
        ///</summary>
        [<ApiMember(DataType="integer", Description="ClassId or ClassScheduleId or SessionSizeId packages which drop credits", Name="CreditFilterId", ParameterType="query")>]
        member val CreditFilterId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
        ///<summary>
        ///Show packages enabled for In App purchase. True or False
        ///</summary>
        [<ApiMember(DataType="string", Description="Show packages enabled for In App purchase. True or False", Name="InApp", ParameterType="query")>]
        member val InApp:Boolean = new Boolean() with get,set

F# 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: clubready.com 
Accept: text/csv