ClubReady Api

<back to all web services

UserAccountInfoRequest

The following routes are available for this service:
GET/users/{UserId}Get user account summary
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 UserAccountInfoRequestDto() = 
        inherit ApiDtoBase()
        member val UserId:Int32 = new Int32() with get,set
        member val FullDetail:Boolean = new Boolean() with get,set

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

    [<AllowNullLiteral>]
    type UserAccountInfoRequest() = 
        inherit UserAccountInfoRequestDto()
        ///<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>
        ///(debug id) Jen A = 28975
        ///</summary>
        [<ApiMember(DataType="integer", Description="(debug id) Jen A = 28975", IsRequired=true, Name="UserId", ParameterType="query")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [<ApiMember(DataType="integer", Description="StoreId OR ChainId is required", 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>
        ///Whether you want full detail to be returned or a basic User object. (Format: true|false(default))
        ///</summary>
        [<ApiMember(DataType="Boolean", Description="Whether you want full detail to be returned or a basic User object. (Format: true|false(default))", Name="FullDetail", ParameterType="query")>]
        member val FullDetail:Boolean = new Boolean() with get,set

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

F# UserAccountInfoRequest 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 /users/{UserId} HTTP/1.1 
Host: clubready.com 
Accept: application/xml