ClubReady Api

GetReferralTypesRequest

The following routes are available for this service:
GET	/club/referral-types	List of referral types.

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


open class GetReferralTypesRequest : ApiDtoBase(), IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * 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

    /**
    * Either StoreId or ChainId is required
    */
    @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * Either StoreId or ChainId is required
    */
    @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

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

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

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

open class GetReferralTypesResponse : GetReferralTypesResponseDto()
{
    var ReferralTypes:ArrayList<ApiGenericType> = ArrayList<ApiGenericType>()
}

open class GetReferralTypesResponseDto
{
    var ReferralTypes:ArrayList<ApiGenericType> = ArrayList<ApiGenericType>()
}

open class ApiGenericType
{
    var Id:Int? = null
    var Name:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

Kotlin GetReferralTypesRequest DTOs

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

HTTP + JSV

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

GET /club/referral-types HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReferralTypes: 
	[
		{
			Id: 0,
			Name: String,
			StoreId: 0,
			ChainId: 0
		}
	]
}