| GET | /users/custom-category | List of a user's items for custom categories. |
|---|
namespace ClubReady.Core.Api.Models
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 GetCustomCategoriesUserRequestDto() =
inherit ApiDtoBase()
member val UserId:Int32 = new Int32() with get,set
member val CustomCategoryId:Int32 = new Int32() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type GetCustomCategoriesUserRequest() =
inherit GetCustomCategoriesUserRequestDto()
///<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>
///ClubReady Club ID (StoreID internally)
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///StoreId OR ChainId is required
///</summary>
[<ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")>]
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///ClubReady User ID
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="query")>]
member val UserId:Int32 = new Int32() with get,set
///<summary>
///Custom Category ID
///</summary>
[<ApiMember(DataType="integer", Description="Custom Category ID", Name="CustomCategoryId", ParameterType="query")>]
member val CustomCategoryId:Int32 = new 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 CustomCategoryItemInfo() =
member val CustomCategoryId:Int32 = new Int32() with get,set
member val CustomCategoryName:String = null with get,set
member val CustomCategoryItemId:Int32 = new Int32() with get,set
member val CustomCategoryItemName:String = null with get,set
[<AllowNullLiteral>]
type GetCustomCategoriesUserResponseDto() =
inherit ApiResponseBase()
member val UserId:Int32 = new Int32() with get,set
member val CustomCategories:ResizeArray<CustomCategoryItemInfo> = new ResizeArray<CustomCategoryItemInfo>() with get,set
[<AllowNullLiteral>]
type GetCustomCategoriesUserResponse() =
inherit GetCustomCategoriesUserResponseDto()
member val UserId:Int32 = new Int32() with get,set
member val CustomCategories:ResizeArray<CustomCategoryItemInfo> = new ResizeArray<CustomCategoryItemInfo>() with get,set
F# GetCustomCategoriesUserRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UserId: 0,
CustomCategories:
[
{
CustomCategoryId: 0,
CustomCategoryName: String,
CustomCategoryItemId: 0,
CustomCategoryItemName: String
}
],
Success: False,
Message: String
}