ClubManager.Api

ViewUserGetUsers

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/UserGetUsers

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="UserGetUsers")
open class ViewUserGetUsers : QueryDb<UserGetUsersInstance>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    var Skip:Int? = null

    @DataMember(Order=2)
    var Take:Int? = null

    @DataMember(Order=3)
    var OrderBy:String? = null

    @DataMember(Order=4)
    var OrderByDesc:String? = null

    @DataMember(Order=5)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class UserGetUsersInstance
{
    var User:UserInstance? = null
    @References(UserInstance.class)
    var UserId:Int? = null

    var UserName:String? = null
    var Name:String? = null
    var Email:String? = null
    var MobilePhone:String? = null
    var Enabled:Boolean? = null
    var LastLogin:Date? = null
    var Created:Date? = null
    var Training:Boolean? = null
    var Deleted:Boolean? = null
    var CoursesCompleted:Int? = null
    var DisplayHomeNotification:Boolean? = null
    var TwoFactorEnabled:Boolean? = null
    var EmailConfirmed:Boolean? = null
    var MobilePhoneConfirmed:Boolean? = null
    var Notifications:Boolean? = null
    var ChangePassword:Date? = null
    var Activated:Date? = null
    var Member:MemberInstance? = null
    @References(MemberInstance.class)
    var MemberId:Int? = null

    var ParentBranchId:Int? = null
    var Domain:String? = null
    var Identity:String? = null
    var BranchName:String? = null
    var BranchKey:UUID? = null
    var PublishableKey:String? = null
    var SecretKey:String? = null
}

open class UserInstance
{
    var UserId:Int? = null
    var UserName:String? = null
    var Name:String? = null
    var Email:String? = null
    var MobilePhone:String? = null
    var Enabled:Boolean? = null
    var LastLogin:Date? = null
    var Created:Date? = null
    var Training:Boolean? = null
    var Deleted:Boolean? = null
    var CoursesCompleted:Int? = null
    var DisplayHomeNotification:Boolean? = null
    var TwoFactorEnabled:Boolean? = null
    var EmailConfirmed:Boolean? = null
    var MobilePhoneConfirmed:Boolean? = null
    var Notifications:Boolean? = null
    var ChangePassword:Date? = null
    var Activated:Date? = null
}

open class MemberInstance
{
    var MemberId:Int? = null
    var MemberType:Int? = null
    var MembershipNumber:String? = null
    var CardNumber:String? = null
    var CompanyName:String? = null
    var Surname:String? = null
    var Forenames:String? = null
    var Title:String? = null
    var Gender:Int? = null
    var DateOfBirth:Date? = null
    var Address1:String? = null
    var Address2:String? = null
    var City:String? = null
    var County:String? = null
    var Postcode:String? = null
    var HomePhone:String? = null
    var MobilePhone:String? = null
    var EmailAddress:String? = null
    var EmailOptOut:Boolean? = null
    var SmsOptOut:Boolean? = null
    var PhoneOptOut:Boolean? = null
    var LetterOptOut:Boolean? = null
    var DirectDebitAccountHolder:String? = null
    var DirectDebitAccountNumber:String? = null
    var DirectDebitSortCode:String? = null
    var JoinedDate:Date? = null
    var DirectDebitBankAddress:String? = null
    var FullName:String? = null
    var ExternalReference:String? = null
    var Photo:ByteArray? = null
    var PhotoModifiedDate:Date? = null
    var Notes:String? = null
    var Deleted:Boolean? = null
    var Demo:Boolean? = null
    var UseExternalStatus:Boolean? = null
    var ExternalStatus:Int? = null
    var FreeText:String? = null
    var MemberKey:UUID? = null
    var Balance:BigDecimal? = null
    var CreditLimit:BigDecimal? = null
    var CreatedDate:Date? = null
    var ModifiedDate:Date? = null
    var DeletedDate:Date? = null
    var ExternalSource:Int? = null
    var RetentionMetric:BigDecimal? = null
    var MonthlyAttendanceFrequency:BigDecimal? = null
    var AssignedToUserId:Int? = null
    var CreatedByUserId:Int? = null
    var DeletedByUserId:Int? = null
    var LossReason:LossReasonInstance? = null
    @References(LossReasonInstance.class)
    var LossReasonId:Int? = null

    var WonOrLost:Int? = null
    var WonOrLostDate:Date? = null
    var GiftAidPermission:Boolean? = null
    var PhotoPermission:Boolean? = null
    var FirstAidPermission:Boolean? = null
    var EmergencyContact:String? = null
    var WonOrLostByUser:UserInstance? = null
    @References(UserInstance.class)
    var WonOrLostByUserId:Int? = null

    var AgreedToTerms:Date? = null
    var OnlineBookingBanned:Boolean? = null
    var Country:String? = null
    var FingerprintEnrolled:Date? = null
    var LastPaymentAmount:BigDecimal? = null
    var Pin:String? = null
    var ProspectingPoints:Int? = null
    var AchievementPoints:Int? = null
    var ParentForenames:String? = null
    var ParentSurname:String? = null
}

open class LossReasonInstance
{
    var LossReasonId:Int? = null
    var Reason:String? = null
    var Deleted:Boolean? = null
    var Demo:Boolean? = null
    var Selectable:Boolean? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

Kotlin ViewUserGetUsers 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.

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

<ViewUserGetUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ViewUserGetUsers>

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

<QueryResponseOfUserGetUsersInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:UserGetUsersInstance>
      <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
      <d2p1:BranchKey>00000000-0000-0000-0000-000000000000</d2p1:BranchKey>
      <d2p1:BranchName>String</d2p1:BranchName>
      <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
      <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
      <d2p1:Domain>String</d2p1:Domain>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
      <d2p1:Enabled>false</d2p1:Enabled>
      <d2p1:Identity>String</d2p1:Identity>
      <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
      <d2p1:Member>
        <d2p1:AchievementPoints>0</d2p1:AchievementPoints>
        <d2p1:Address1>String</d2p1:Address1>
        <d2p1:Address2>String</d2p1:Address2>
        <d2p1:AgreedToTerms>0001-01-01T00:00:00</d2p1:AgreedToTerms>
        <d2p1:AssignedToUserId>0</d2p1:AssignedToUserId>
        <d2p1:Balance>0</d2p1:Balance>
        <d2p1:CardNumber>String</d2p1:CardNumber>
        <d2p1:City>String</d2p1:City>
        <d2p1:CompanyName>String</d2p1:CompanyName>
        <d2p1:Country>String</d2p1:Country>
        <d2p1:County>String</d2p1:County>
        <d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
        <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
        <d2p1:CreditLimit>0</d2p1:CreditLimit>
        <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:DeletedByUserId>0</d2p1:DeletedByUserId>
        <d2p1:DeletedDate>0001-01-01T00:00:00</d2p1:DeletedDate>
        <d2p1:Demo>false</d2p1:Demo>
        <d2p1:DirectDebitAccountHolder>String</d2p1:DirectDebitAccountHolder>
        <d2p1:DirectDebitAccountNumber>String</d2p1:DirectDebitAccountNumber>
        <d2p1:DirectDebitBankAddress>String</d2p1:DirectDebitBankAddress>
        <d2p1:DirectDebitSortCode>String</d2p1:DirectDebitSortCode>
        <d2p1:EmailAddress>String</d2p1:EmailAddress>
        <d2p1:EmailOptOut>false</d2p1:EmailOptOut>
        <d2p1:EmergencyContact>String</d2p1:EmergencyContact>
        <d2p1:ExternalReference>String</d2p1:ExternalReference>
        <d2p1:ExternalSource>0</d2p1:ExternalSource>
        <d2p1:ExternalStatus>0</d2p1:ExternalStatus>
        <d2p1:FingerprintEnrolled>0001-01-01T00:00:00</d2p1:FingerprintEnrolled>
        <d2p1:FirstAidPermission>false</d2p1:FirstAidPermission>
        <d2p1:Forenames>String</d2p1:Forenames>
        <d2p1:FreeText>String</d2p1:FreeText>
        <d2p1:FullName>String</d2p1:FullName>
        <d2p1:Gender>0</d2p1:Gender>
        <d2p1:GiftAidPermission>false</d2p1:GiftAidPermission>
        <d2p1:HomePhone>String</d2p1:HomePhone>
        <d2p1:JoinedDate>0001-01-01T00:00:00</d2p1:JoinedDate>
        <d2p1:LastPaymentAmount>0</d2p1:LastPaymentAmount>
        <d2p1:LetterOptOut>false</d2p1:LetterOptOut>
        <d2p1:LossReason>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:Demo>false</d2p1:Demo>
          <d2p1:LossReasonId>0</d2p1:LossReasonId>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:Selectable>false</d2p1:Selectable>
        </d2p1:LossReason>
        <d2p1:LossReasonId>0</d2p1:LossReasonId>
        <d2p1:MemberId>0</d2p1:MemberId>
        <d2p1:MemberKey>00000000-0000-0000-0000-000000000000</d2p1:MemberKey>
        <d2p1:MemberType>0</d2p1:MemberType>
        <d2p1:MembershipNumber>String</d2p1:MembershipNumber>
        <d2p1:MobilePhone>String</d2p1:MobilePhone>
        <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:MonthlyAttendanceFrequency>0</d2p1:MonthlyAttendanceFrequency>
        <d2p1:Notes>String</d2p1:Notes>
        <d2p1:OnlineBookingBanned>false</d2p1:OnlineBookingBanned>
        <d2p1:ParentForenames>String</d2p1:ParentForenames>
        <d2p1:ParentSurname>String</d2p1:ParentSurname>
        <d2p1:PhoneOptOut>false</d2p1:PhoneOptOut>
        <d2p1:Photo>AA==</d2p1:Photo>
        <d2p1:PhotoModifiedDate>0001-01-01T00:00:00</d2p1:PhotoModifiedDate>
        <d2p1:PhotoPermission>false</d2p1:PhotoPermission>
        <d2p1:Pin>String</d2p1:Pin>
        <d2p1:Postcode>String</d2p1:Postcode>
        <d2p1:ProspectingPoints>0</d2p1:ProspectingPoints>
        <d2p1:RetentionMetric>0</d2p1:RetentionMetric>
        <d2p1:SmsOptOut>false</d2p1:SmsOptOut>
        <d2p1:Surname>String</d2p1:Surname>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:UseExternalStatus>false</d2p1:UseExternalStatus>
        <d2p1:WonOrLost>0</d2p1:WonOrLost>
        <d2p1:WonOrLostByUser>
          <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
          <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
          <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
          <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
          <d2p1:Deleted>false</d2p1:Deleted>
          <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
          <d2p1:Enabled>false</d2p1:Enabled>
          <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
          <d2p1:MobilePhone>String</d2p1:MobilePhone>
          <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Notifications>false</d2p1:Notifications>
          <d2p1:Training>false</d2p1:Training>
          <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
          <d2p1:UserId>0</d2p1:UserId>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:WonOrLostByUser>
        <d2p1:WonOrLostByUserId>0</d2p1:WonOrLostByUserId>
        <d2p1:WonOrLostDate>0001-01-01T00:00:00</d2p1:WonOrLostDate>
      </d2p1:Member>
      <d2p1:MemberId>0</d2p1:MemberId>
      <d2p1:MobilePhone>String</d2p1:MobilePhone>
      <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Notifications>false</d2p1:Notifications>
      <d2p1:ParentBranchId>0</d2p1:ParentBranchId>
      <d2p1:PublishableKey>String</d2p1:PublishableKey>
      <d2p1:SecretKey>String</d2p1:SecretKey>
      <d2p1:Training>false</d2p1:Training>
      <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
      <d2p1:User>
        <d2p1:Activated>0001-01-01T00:00:00</d2p1:Activated>
        <d2p1:ChangePassword>0001-01-01T00:00:00</d2p1:ChangePassword>
        <d2p1:CoursesCompleted>0</d2p1:CoursesCompleted>
        <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:DisplayHomeNotification>false</d2p1:DisplayHomeNotification>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:EmailConfirmed>false</d2p1:EmailConfirmed>
        <d2p1:Enabled>false</d2p1:Enabled>
        <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
        <d2p1:MobilePhone>String</d2p1:MobilePhone>
        <d2p1:MobilePhoneConfirmed>false</d2p1:MobilePhoneConfirmed>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Notifications>false</d2p1:Notifications>
        <d2p1:Training>false</d2p1:Training>
        <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:UserName>String</d2p1:UserName>
      </d2p1:User>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:UserGetUsersInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfUserGetUsersInstancePEZRWkv_P>