ClubReady Api

GetCustomCategoriesRequest

The following routes are available for this service:
GET	/club/custom-category	List of custom categories.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Club.Models
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 ApiGenericType
            Public Overridable Property Id As Integer
            Public Overridable Property Name 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 CustomCategoryInfo
            Inherits ApiGenericType
            Public Overridable Property ItemCount As Integer
        End Class

        Public Partial Class GetCustomCategoriesRequestDto
            Inherits ApiDtoBase
            Public Overridable Property CustomCategoryId As Integer
        End Class

        Public Partial Class GetCustomCategoriesResponseDto
            Inherits ApiResponseBase
            Public Sub New()
                CustomCategories = New List(Of CustomCategoryInfo)
            End Sub

            Public Overridable Property CustomCategories As List(Of CustomCategoryInfo)
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Club.Models

        Public Partial Class GetCustomCategoriesRequest
            Inherits GetCustomCategoriesRequestDto
            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>
            '''Either StoreId or ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Either StoreId or ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

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

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

        Public Partial Class GetCustomCategoriesResponse
            Inherits GetCustomCategoriesResponseDto
            Public Sub New()
                CustomCategories = New List(Of CustomCategoryInfo)
            End Sub

            Public Overridable Property CustomCategories As List(Of CustomCategoryInfo)
            Public Overridable Property Success As Boolean
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET GetCustomCategoriesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /club/custom-category HTTP/1.1 
Host: clubready.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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