ClubReady Api

GetSalesPackageRequest

The following routes are available for this service:
GET	/sales/package/{PackageId}	Get sales package details

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 GetSalesPackageRequestDto
            Inherits ApiDtoBase
            Public Overridable Property PackageId As Integer
        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 GetSalesPackageRequest
            Inherits GetSalesPackageRequestDto
            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 package details for. <br//> Either StoreId or ChainId is required
            '''</Summary>
            <ApiMember(DataType:="string", Description:="ID # of store to get package details for. <br//> Either StoreId or ChainId is required", Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''ID # of chain to get package details for. <br//> Either StoreId or ChainId is required
            '''</Summary>
            <ApiMember(DataType:="string", Description:="ID # of chain to get package details for. <br//> Either StoreId or ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''ID # of package to get details for
            '''</Summary>
            <ApiMember(DataType:="string", Description:="ID # of package to get details for", IsRequired:=true, Name:="PackageId", ParameterType:="path")>
            Public Overridable Property PackageId As Integer

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class
    End Namespace
End Namespace

VB.NET GetSalesPackageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sales/package/{PackageId} HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml