ClubManager.Api

<back to all web services

ViewUserGetUsers

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/UserGetUsers
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Api.Services.Query

Namespace Global

    Namespace ClubManager.Api.Services.Query

        Public Partial Class LossReasonInstance
            Public Overridable Property LossReasonId As Integer
            Public Overridable Property Reason As String
            Public Overridable Property Deleted As Boolean
            Public Overridable Property Demo As Boolean
            Public Overridable Property Selectable As Boolean
        End Class

        Public Partial Class MemberInstance
            Public Sub New()
                Photo = New Byte(){}
            End Sub

            Public Overridable Property MemberId As Integer
            Public Overridable Property MemberType As Integer
            Public Overridable Property MembershipNumber As String
            Public Overridable Property CardNumber As String
            Public Overridable Property CompanyName As String
            Public Overridable Property Surname As String
            Public Overridable Property Forenames As String
            Public Overridable Property Title As String
            Public Overridable Property Gender As Integer
            Public Overridable Property DateOfBirth As Nullable(Of Date)
            Public Overridable Property Address1 As String
            Public Overridable Property Address2 As String
            Public Overridable Property City As String
            Public Overridable Property County As String
            Public Overridable Property Postcode As String
            Public Overridable Property HomePhone As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property EmailOptOut As Boolean
            Public Overridable Property SmsOptOut As Boolean
            Public Overridable Property PhoneOptOut As Boolean
            Public Overridable Property LetterOptOut As Boolean
            Public Overridable Property DirectDebitAccountHolder As String
            Public Overridable Property DirectDebitAccountNumber As String
            Public Overridable Property DirectDebitSortCode As String
            Public Overridable Property JoinedDate As Nullable(Of Date)
            Public Overridable Property DirectDebitBankAddress As String
            Public Overridable Property FullName As String
            Public Overridable Property ExternalReference As String
            Public Overridable Property Photo As Byte()
            Public Overridable Property PhotoModifiedDate As Nullable(Of Date)
            Public Overridable Property Notes As String
            Public Overridable Property Deleted As Boolean
            Public Overridable Property Demo As Boolean
            Public Overridable Property UseExternalStatus As Boolean
            Public Overridable Property ExternalStatus As Integer
            Public Overridable Property FreeText As String
            Public Overridable Property MemberKey As Nullable(Of Guid)
            Public Overridable Property Balance As Decimal
            Public Overridable Property CreditLimit As Decimal
            Public Overridable Property CreatedDate As Date
            Public Overridable Property ModifiedDate As Nullable(Of Date)
            Public Overridable Property DeletedDate As Nullable(Of Date)
            Public Overridable Property ExternalSource As Integer
            Public Overridable Property RetentionMetric As Nullable(Of Decimal)
            Public Overridable Property MonthlyAttendanceFrequency As Nullable(Of Decimal)
            Public Overridable Property AssignedToUserId As Nullable(Of Integer)
            Public Overridable Property CreatedByUserId As Nullable(Of Integer)
            Public Overridable Property DeletedByUserId As Nullable(Of Integer)
            Public Overridable Property LossReason As LossReasonInstance
            <References(GetType(LossReasonInstance))>
            Public Overridable Property LossReasonId As Nullable(Of Integer)

            Public Overridable Property WonOrLost As Nullable(Of Integer)
            Public Overridable Property WonOrLostDate As Nullable(Of Date)
            Public Overridable Property GiftAidPermission As Boolean
            Public Overridable Property PhotoPermission As Nullable(Of Boolean)
            Public Overridable Property FirstAidPermission As Nullable(Of Boolean)
            Public Overridable Property EmergencyContact As String
            Public Overridable Property WonOrLostByUser As UserInstance
            <References(GetType(UserInstance))>
            Public Overridable Property WonOrLostByUserId As Nullable(Of Integer)

            Public Overridable Property AgreedToTerms As Nullable(Of Date)
            Public Overridable Property OnlineBookingBanned As Boolean
            Public Overridable Property Country As String
            Public Overridable Property FingerprintEnrolled As Nullable(Of Date)
            Public Overridable Property LastPaymentAmount As Nullable(Of Decimal)
            Public Overridable Property Pin As String
            Public Overridable Property ProspectingPoints As Integer
            Public Overridable Property AchievementPoints As Integer
            Public Overridable Property ParentForenames As String
            Public Overridable Property ParentSurname As String
        End Class

        Public Partial Class UserGetUsersInstance
            Public Overridable Property User As UserInstance
            <References(GetType(UserInstance))>
            Public Overridable Property UserId As Integer

            Public Overridable Property UserName As String
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property LastLogin As Nullable(Of Date)
            Public Overridable Property Created As Date
            Public Overridable Property Training As Boolean
            Public Overridable Property Deleted As Boolean
            Public Overridable Property CoursesCompleted As Integer
            Public Overridable Property DisplayHomeNotification As Nullable(Of Boolean)
            Public Overridable Property TwoFactorEnabled As Boolean
            Public Overridable Property EmailConfirmed As Boolean
            Public Overridable Property MobilePhoneConfirmed As Boolean
            Public Overridable Property Notifications As Boolean
            Public Overridable Property ChangePassword As Nullable(Of Date)
            Public Overridable Property Activated As Nullable(Of Date)
            Public Overridable Property Member As MemberInstance
            <References(GetType(MemberInstance))>
            Public Overridable Property MemberId As Nullable(Of Integer)

            Public Overridable Property ParentBranchId As Nullable(Of Integer)
            Public Overridable Property Domain As String
            Public Overridable Property Identity As String
            Public Overridable Property BranchName As String
            Public Overridable Property BranchKey As Nullable(Of Guid)
            Public Overridable Property PublishableKey As String
            Public Overridable Property SecretKey As String
        End Class

        Public Partial Class UserInstance
            Public Overridable Property UserId As Integer
            Public Overridable Property UserName As String
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property MobilePhone As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property LastLogin As Nullable(Of Date)
            Public Overridable Property Created As Date
            Public Overridable Property Training As Boolean
            Public Overridable Property Deleted As Boolean
            Public Overridable Property CoursesCompleted As Integer
            Public Overridable Property DisplayHomeNotification As Nullable(Of Boolean)
            Public Overridable Property TwoFactorEnabled As Boolean
            Public Overridable Property EmailConfirmed As Boolean
            Public Overridable Property MobilePhoneConfirmed As Boolean
            Public Overridable Property Notifications As Boolean
            Public Overridable Property ChangePassword As Nullable(Of Date)
            Public Overridable Property Activated As Nullable(Of Date)
        End Class

        <AutoQueryViewer(Description:="", IconUrl:="octicon:database", Title:="UserGetUsers")>
        Public Partial Class ViewUserGetUsers
            Inherits QueryDb(Of UserGetUsersInstance)
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ViewUserGetUsers DTOs

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

HTTP + CSV

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

POST /api/Query/UserGetUsers HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"User":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000","Member":{"MemberId":0,"MemberType":0,"MembershipNumber":"String","CardNumber":"String","CompanyName":"String","Surname":"String","Forenames":"String","Title":"String","Gender":0,"DateOfBirth":"0001-01-01T00:00:00.0000000","Address1":"String","Address2":"String","City":"String","County":"String","Postcode":"String","HomePhone":"String","MobilePhone":"String","EmailAddress":"String","EmailOptOut":false,"SmsOptOut":false,"PhoneOptOut":false,"LetterOptOut":false,"DirectDebitAccountHolder":"String","DirectDebitAccountNumber":"String","DirectDebitSortCode":"String","JoinedDate":"0001-01-01T00:00:00.0000000","DirectDebitBankAddress":"String","FullName":"String","ExternalReference":"String","Photo":"AA==","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","Notes":"String","Deleted":false,"Demo":false,"UseExternalStatus":false,"ExternalStatus":0,"FreeText":"String","MemberKey":"00000000000000000000000000000000","Balance":0,"CreditLimit":0,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","ExternalSource":0,"RetentionMetric":0,"MonthlyAttendanceFrequency":0,"AssignedToUserId":0,"CreatedByUserId":0,"DeletedByUserId":0,"LossReason":{"LossReasonId":0,"Reason":"String","Deleted":false,"Demo":false,"Selectable":false},"LossReasonId":0,"WonOrLost":0,"WonOrLostDate":"0001-01-01T00:00:00.0000000","GiftAidPermission":false,"PhotoPermission":false,"FirstAidPermission":false,"EmergencyContact":"String","WonOrLostByUser":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"WonOrLostByUserId":0,"AgreedToTerms":"0001-01-01T00:00:00.0000000","OnlineBookingBanned":false,"Country":"String","FingerprintEnrolled":"0001-01-01T00:00:00.0000000","LastPaymentAmount":0,"Pin":"String","ProspectingPoints":0,"AchievementPoints":0,"ParentForenames":"String","ParentSurname":"String"},"MemberId":0,"ParentBranchId":0,"Domain":"String","Identity":"String","BranchName":"String","BranchKey":"00000000000000000000000000000000","PublishableKey":"String","SecretKey":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}