ClubReady Api

UserAccountInfoRequest

The following routes are available for this service:
GET	/users/{UserId}	Get user account summary

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 ChainId As Nullable(Of Integer)
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
        End Class

        Public Partial Class UserAccountInfoRequestDto
            Inherits ApiDtoBase
            Public Overridable Property UserId As Integer
            Public Overridable Property FullDetail As Boolean
        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 UserAccountInfoRequest
            Inherits UserAccountInfoRequestDto
            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>
            '''(debug id) Jen A = 28975
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="(debug id) Jen A = 28975", IsRequired:=true, Name:="UserId", ParameterType:="query")>
            Public Overridable Property UserId As Integer

            '''<Summary>
            '''StoreId OR ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", 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>
            '''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")>
            Public Overridable Property FullDetail As Boolean

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

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