ClubReady Api

<back to all web services

GetCustomCategoriesRequest

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 ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CustomCategoryInfo
        : ApiGenericType
    {
        public virtual int ItemCount { get; set; }
    }

    public partial class GetCustomCategoriesRequestDto
        : ApiDtoBase
    {
        public virtual int CustomCategoryId { get; set; }
    }

    public partial class GetCustomCategoriesResponseDto
        : ApiResponseBase
    {
        public GetCustomCategoriesResponseDto()
        {
            CustomCategories = new List<CustomCategoryInfo>{};
        }

        public virtual List<CustomCategoryInfo> CustomCategories { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Club.Models
{
    public partial class GetCustomCategoriesRequest
        : GetCustomCategoriesRequestDto, 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 GetCustomCategoriesResponse
        : GetCustomCategoriesResponseDto
    {
        public GetCustomCategoriesResponse()
        {
            CustomCategories = new List<CustomCategoryInfo>{};
        }

        public virtual List<CustomCategoryInfo> CustomCategories { get; set; }
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

}

C# GetCustomCategoriesRequest DTOs

GET /club/custom-category HTTP/1.1 
Host: clubready.com 
Accept: text/csv

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

{"CustomCategories":[{"ItemCount":0,"Id":0,"Name":"String","StoreId":0,"ChainId":0}],"Success":false,"Message":"String"}