ClubReady Api

<back to all web services

GetMembershipTypesRequest

The following routes are available for this service:
GET/club/membership-typesList of membership types.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetMembershipTypesRequest extends ApiDtoBase implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Either StoreId or ChainId is required
        */
        @ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetMembershipTypesRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetMembershipTypesRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetMembershipTypesRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetMembershipTypesRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetMembershipTypesRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class GetMembershipTypesResponse extends GetMembershipTypesResponseDto
    {
        public ArrayList<ApiGenericType> MembershipTypes = null;
        
        public ArrayList<ApiGenericType> getMembershipTypes() { return MembershipTypes; }
        public GetMembershipTypesResponse setMembershipTypes(ArrayList<ApiGenericType> value) { this.MembershipTypes = value; return this; }
    }

    public static class GetMembershipTypesResponseDto
    {
        public ArrayList<ApiGenericType> MembershipTypes = null;
        
        public ArrayList<ApiGenericType> getMembershipTypes() { return MembershipTypes; }
        public GetMembershipTypesResponseDto setMembershipTypes(ArrayList<ApiGenericType> value) { this.MembershipTypes = value; return this; }
    }

    public static class ApiGenericType
    {
        public Integer Id = null;
        public String Name = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public Integer getId() { return Id; }
        public ApiGenericType setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ApiGenericType setName(String value) { this.Name = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiGenericType setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiGenericType setChainId(Integer value) { this.ChainId = value; return this; }
    }

}

Java GetMembershipTypesRequest 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/membership-types HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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