ClubReady Api

<back to all web services

GetCustomCategoriesUserRequest

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Members.Model;
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 ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CustomCategoryItemInfo
    {
        public virtual int CustomCategoryId { get; set; }
        public virtual string CustomCategoryName { get; set; }
        public virtual int CustomCategoryItemId { get; set; }
        public virtual string CustomCategoryItemName { get; set; }
    }

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

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

        public virtual int UserId { get; set; }
        public virtual List<CustomCategoryItemInfo> CustomCategories { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class GetCustomCategoriesUserRequest
        : GetCustomCategoriesUserRequestDto, 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>
        ///ClubReady Club ID (StoreID internally)
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

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

        ///<summary>
        ///ClubReady User ID
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")]
        public virtual int UserId { get; set; }

        ///<summary>
        ///Custom Category ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")]
        public virtual int CustomCategoryId { get; set; }

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

    public partial class GetCustomCategoriesUserResponse
        : GetCustomCategoriesUserResponseDto
    {
        public GetCustomCategoriesUserResponse()
        {
            CustomCategories = new List<CustomCategoryItemInfo>{};
        }

        public virtual int UserId { get; set; }
        public virtual List<CustomCategoryItemInfo> CustomCategories { get; set; }
    }

}

C# GetCustomCategoriesUserRequest DTOs

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

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

{"UserId":0,"CustomCategories":[{"CustomCategoryId":0,"CustomCategoryName":"String","CustomCategoryItemId":0,"CustomCategoryItemName":"String"}],"Success":false,"Message":"String"}