ClubReady Api

PackageEligibilityRequest

The following routes are available for this service:
GET	/sales/members/{MemberId}/package-eligibility	Find out is a user is eligible to purchase a certain package.

import java.math.*
import java.util.*
import net.servicestack.client.*


open class PackageEligibilityRequest : PackageEligibilityRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * Store ID # member belongs to
    */
    @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID of the member to lookup
    */
    @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
    var MemberId:Int? = null

    /**
    * ID of the package to check
    */
    @ApiMember(DataType="integer", Description="ID of the package to check", IsRequired=true, Name="PackageId", ParameterType="query")
    var PackageId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class PackageEligibilityRequestDto : ApiDtoBase()
{
    var PackageId:Int? = null
    var MemberId:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class PackageEligibilityResponse : PackageEligibilityResponseDto()
{
    var EligibilityInfo:PackageEligibility? = null
}

open class PackageEligibilityResponseDto : ApiResponseBase()
{
    var EligibilityInfo:PackageEligibility? = null
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

open class PackageEligibility
{
    var IsEligible:Boolean? = null
    var Eligibility:ArrayList<PackageEligibilityItem> = ArrayList<PackageEligibilityItem>()
}

open class PackageEligibilityItem
{
    var Name:String? = null
    var Value:String? = null
    var IsEligible:Boolean? = null
    var Message:String? = null
}

Kotlin 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>