ClubReady Api

GetCustomCategoriesRequest

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

namespace ClubReady.Core.Api

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type GetCustomCategoriesRequestDto() = 
        inherit ApiDtoBase()
        member val CustomCategoryId:Int32 = new Int32() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type GetCustomCategoriesRequest() = 
        inherit GetCustomCategoriesRequestDto()
        ///<summary>
        ///IP address of the end user
        ///</summary>
        [<ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")>]
        member val XForwardedFor:String = null with get,set

        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<AllowNullLiteral>]
    type ApiResponseBase() = 
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type ApiGenericType() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type CustomCategoryInfo() = 
        inherit ApiGenericType()
        member val ItemCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GetCustomCategoriesResponseDto() = 
        inherit ApiResponseBase()
        member val CustomCategories:ResizeArray<CustomCategoryInfo> = new ResizeArray<CustomCategoryInfo>() with get,set

    [<AllowNullLiteral>]
    type GetCustomCategoriesResponse() = 
        inherit GetCustomCategoriesResponseDto()
        member val CustomCategories:ResizeArray<CustomCategoryInfo> = new ResizeArray<CustomCategoryInfo>() with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

F# GetCustomCategoriesRequest DTOs

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

HTTP + XML

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: www.clubready.com 
Accept: application/xml

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

<GetCustomCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Club.Models">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <CustomCategories xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <CustomCategoryInfo>
      <ChainId>0</ChainId>
      <Id>0</Id>
      <Name>String</Name>
      <StoreId>0</StoreId>
      <ItemCount>0</ItemCount>
    </CustomCategoryInfo>
  </CustomCategories>
</GetCustomCategoriesResponse>