ClubManager.Api

ViewUserGetUsers

**Requires Authentication**
Required role:	API

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

namespace ClubManager.Api.Services.Query

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserInstance() = 
        member val UserId:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val CoursesCompleted:Int32 = new Int32() with get,set
        member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type LossReasonInstance() = 
        member val LossReasonId:Int32 = new Int32() with get,set
        member val Reason:String = null with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val Selectable:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type MemberInstance() = 
        member val MemberId:Int32 = new Int32() with get,set
        member val MemberType:Int32 = new Int32() with get,set
        member val MembershipNumber:String = null with get,set
        member val CardNumber:String = null with get,set
        member val CompanyName:String = null with get,set
        member val Surname:String = null with get,set
        member val Forenames:String = null with get,set
        member val Title:String = null with get,set
        member val Gender:Int32 = new Int32() with get,set
        member val DateOfBirth:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val County:String = null with get,set
        member val Postcode:String = null with get,set
        member val HomePhone:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val EmailOptOut:Boolean = new Boolean() with get,set
        member val SmsOptOut:Boolean = new Boolean() with get,set
        member val PhoneOptOut:Boolean = new Boolean() with get,set
        member val LetterOptOut:Boolean = new Boolean() with get,set
        member val DirectDebitAccountHolder:String = null with get,set
        member val DirectDebitAccountNumber:String = null with get,set
        member val DirectDebitSortCode:String = null with get,set
        member val JoinedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DirectDebitBankAddress:String = null with get,set
        member val FullName:String = null with get,set
        member val ExternalReference:String = null with get,set
        member val Photo:Byte[] = [||] with get,set
        member val PhotoModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Notes:String = null with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val UseExternalStatus:Boolean = new Boolean() with get,set
        member val ExternalStatus:Int32 = new Int32() with get,set
        member val FreeText:String = null with get,set
        member val MemberKey:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Balance:Decimal = new Decimal() with get,set
        member val CreditLimit:Decimal = new Decimal() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeletedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExternalSource:Int32 = new Int32() with get,set
        member val RetentionMetric:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MonthlyAttendanceFrequency:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AssignedToUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeletedByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LossReason:LossReasonInstance = null with get,set
        [<References(typeof<LossReasonInstance>)>]
        member val LossReasonId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val WonOrLost:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WonOrLostDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val GiftAidPermission:Boolean = new Boolean() with get,set
        member val PhotoPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val FirstAidPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val EmergencyContact:String = null with get,set
        member val WonOrLostByUser:UserInstance = null with get,set
        [<References(typeof<UserInstance>)>]
        member val WonOrLostByUserId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val AgreedToTerms:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OnlineBookingBanned:Boolean = new Boolean() with get,set
        member val Country:String = null with get,set
        member val FingerprintEnrolled:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LastPaymentAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Pin:String = null with get,set
        member val ProspectingPoints:Int32 = new Int32() with get,set
        member val AchievementPoints:Int32 = new Int32() with get,set
        member val ParentForenames:String = null with get,set
        member val ParentSurname:String = null with get,set

    [<AllowNullLiteral>]
    type UserGetUsersInstance() = 
        member val User:UserInstance = null with get,set
        [<References(typeof<UserInstance>)>]
        member val UserId:Int32 = new Int32() with get,set

        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val CoursesCompleted:Int32 = new Int32() with get,set
        member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Member:MemberInstance = null with get,set
        [<References(typeof<MemberInstance>)>]
        member val MemberId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val ParentBranchId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Domain:String = null with get,set
        member val Identity:String = null with get,set
        member val BranchName:String = null with get,set
        member val BranchKey:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val PublishableKey:String = null with get,set
        member val SecretKey:String = null with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="UserGetUsers")>]
    [<AllowNullLiteral>]
    type ViewUserGetUsers() = 
        inherit QueryDb<UserGetUsersInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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>