ClubReady Api

<back to all web services

PackageEligibilityRequest

The following routes are available for this service:
GET/sales/members/{MemberId}/package-eligibilityFind out is a user is eligible to purchase a certain package.
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
Imports ClubReady.Core.Sales.Models

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 ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class PackageEligibilityRequestDto
            Inherits ApiDtoBase
            Public Overridable Property PackageId As Integer
            Public Overridable Property MemberId As Integer
        End Class

        Public Partial Class PackageEligibilityResponseDto
            Inherits ApiResponseBase
            Public Overridable Property EligibilityInfo As PackageEligibility
        End Class
    End Namespace

    Namespace ClubReady.Core.Sales.Models

        Public Partial Class PackageEligibility
            Public Sub New()
                Eligibility = New List(Of PackageEligibilityItem)
            End Sub

            Public Overridable Property IsEligible As Boolean
            Public Overridable Property Eligibility As List(Of PackageEligibilityItem)
        End Class

        Public Partial Class PackageEligibilityItem
            Public Overridable Property Name As String
            Public Overridable Property Value As String
            Public Overridable Property IsEligible As Boolean
            Public Overridable Property Message As String
        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 PackageEligibilityRequest
            Inherits PackageEligibilityRequestDto
            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>
            '''Store ID # member belongs to
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Store ID # member belongs to", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''ID of the member to lookup
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ID of the member to lookup", IsRequired:=true, Name:="MemberId", ParameterType:="path")>
            Public Overridable Property MemberId As Integer

            '''<Summary>
            '''ID of the package to check
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ID of the package to check", IsRequired:=true, Name:="PackageId", ParameterType:="query")>
            Public Overridable Property PackageId As Integer

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

        Public Partial Class PackageEligibilityResponse
            Inherits PackageEligibilityResponseDto
            Public Overridable Property EligibilityInfo As PackageEligibility
        End Class
    End Namespace
End Namespace

VB.NET PackageEligibilityRequest 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/members/{MemberId}/package-eligibility HTTP/1.1 
Host: clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PackageEligibilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <EligibilityInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Sales.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:Eligibility>
      <d2p1:PackageEligibilityItem>
        <d2p1:IsEligible>false</d2p1:IsEligible>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:PackageEligibilityItem>
    </d2p1:Eligibility>
    <d2p1:IsEligible>false</d2p1:IsEligible>
  </EligibilityInfo>
</PackageEligibilityResponse>