ClubReady Api

GetCustomCategoriesUserRequest

The following routes are available for this service:
GET	/users/custom-category	List of a user's items for custom categories.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class ApiResponseBase
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class

        Public Partial Class CustomCategoryItemInfo
            Public Overridable Property CustomCategoryId As Integer
            Public Overridable Property CustomCategoryName As String
            Public Overridable Property CustomCategoryItemId As Integer
            Public Overridable Property CustomCategoryItemName As String
        End Class

        Public Partial Class GetCustomCategoriesUserRequestDto
            Inherits ApiDtoBase
            Public Overridable Property UserId As Integer
            Public Overridable Property CustomCategoryId As Integer
        End Class

        Public Partial Class GetCustomCategoriesUserResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                CustomCategories = New List(Of CustomCategoryItemInfo)
            End Sub

            Public Overridable Property UserId As Integer
            Public Overridable Property CustomCategories As List(Of CustomCategoryItemInfo)
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class GetCustomCategoriesUserRequest
            Inherits GetCustomCategoriesUserRequestDto
            Implements 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 Overridable Property ApiKey As String

            '''<Summary>
            '''ClubReady Club ID (StoreID internally)
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady Club ID (StoreID internally)", Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''StoreId OR ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''ClubReady User ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady User ID", IsRequired:=true, Name:="UserId", ParameterType:="query")>
            Public Overridable Property UserId As Integer

            '''<Summary>
            '''Custom Category ID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Custom Category ID", Name:="CustomCategoryId", ParameterType:="query")>
            Public Overridable Property CustomCategoryId As Integer

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class

        Public Partial Class GetCustomCategoriesUserResponse
            Inherits GetCustomCategoriesUserResponseDto
            Public Sub New()
                CustomCategories = New List(Of CustomCategoryItemInfo)
            End Sub

            Public Overridable Property UserId As Integer
            Public Overridable Property CustomCategories As List(Of CustomCategoryItemInfo)
        End Class
    End Namespace
End Namespace

VB.NET GetCustomCategoriesUserRequest DTOs

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

HTTP + CSV

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

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"}