ClubReady Api

GetReferralTypesRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Club.Models;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiGenericType
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class GetReferralTypesResponseDto
    {
        public GetReferralTypesResponseDto()
        {
            ReferralTypes = new List<ApiGenericType>{};
        }

        public virtual List<ApiGenericType> ReferralTypes { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Club.Models
{
    public partial class GetReferralTypesRequest
        : ApiDtoBase, 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 virtual string ApiKey { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class GetReferralTypesResponse
        : GetReferralTypesResponseDto
    {
        public GetReferralTypesResponse()
        {
            ReferralTypes = new List<ApiGenericType>{};
        }

        public virtual List<ApiGenericType> ReferralTypes { get; set; }
    }

}

C# 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
		}
	]
}