ClubReady Api

<back to all web services

GetSalesPackagesRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Sales.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class GetSalesPackagesRequestDto
            Inherits ApiDtoBase
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Sales.Model

        Public Partial Class GetSalesPackagesRequest
            Inherits GetSalesPackagesRequestDto
            Implements IRestrictedApiRequest
            '''<Summary>
            '''Api Key - grants access to resources
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
            Public Overridable Property ApiKey As String

            '''<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")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<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")>
            Public Overridable Property UserId As Nullable(Of Integer)

            '''<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")>
            Public Overridable Property CreditFilterType As Nullable(Of Integer)

            '''<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")>
            Public Overridable Property CreditFilterId As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
            '''<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")>
            Public Overridable Property InApp As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetSalesPackagesRequest DTOs

GET /sales/packages HTTP/1.1 
Host: clubready.com 
Accept: application/xml