ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranch
import Foundation
import ServiceStack

public class User : Codable
{
    public var userId:Int?
    public var userName:String?
    public var name:String?
    public var email:String?
    public var emailConfirmed:Bool?
    public var mobilePhone:String?
    public var mobilePhoneConfirmed:Bool?
    public var confirmPassword:String?
    public var password:String?
    public var passwordSalt:String?
    public var enabled:Bool?
    public var training:Bool?
    public var lastLogin:Date?
    public var created:Date?
    public var branchId:Int?
    public var parentBranchId:Int?
    public var memberId:Int?
    public var roles:[String] = []
    public var coursesCompleted:TrainingCourse?
    public var displayHomeNotification:Bool?
    public var twoFactorEnabled:Bool?
    public var branchName:String?
    public var branchKey:String?
    public var notifications:Bool?
    public var publishableKey:String?
    public var secretKey:String?
    public var appRegistrationId:String?
    public var appRegistrationLink:String?
    public var appQrImageLink:String?
    public var changePassword:Date?
    public var activated:Date?

    required public init(){}
}

// @Flags()
public enum TrainingCourse : Int, Codable
{
    case AddMember = 1
    case EditMember = 2
    case AddMembership = 4
    case Journal = 8
    case Home = 16
    case Till = 32
    case Accounting = 64
    case UnexplainedPayments = 128
    case Bookings = 256
    case Users = 512
}


Swift SecurityService.GetUserByBranchRequest 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/Security/GetUserByBranch HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SecurityService.GetUserByBranchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Interfaces.Models.Security">
  <_x003C_Activated_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_Activated_x003E_k__BackingField>
  <_x003C_BranchId_x003E_k__BackingField>0</_x003C_BranchId_x003E_k__BackingField>
  <_x003C_BranchKey_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_BranchKey_x003E_k__BackingField>
  <_x003C_BranchName_x003E_k__BackingField>String</_x003C_BranchName_x003E_k__BackingField>
  <_x003C_ChangePassword_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ChangePassword_x003E_k__BackingField>
  <_x003C_ConfirmPassword_x003E_k__BackingField>String</_x003C_ConfirmPassword_x003E_k__BackingField>
  <_x003C_CoursesCompleted_x003E_k__BackingField>AddMember</_x003C_CoursesCompleted_x003E_k__BackingField>
  <_x003C_Created_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_Created_x003E_k__BackingField>
  <_x003C_DisplayHomeNotification_x003E_k__BackingField>false</_x003C_DisplayHomeNotification_x003E_k__BackingField>
  <_x003C_EmailConfirmed_x003E_k__BackingField>false</_x003C_EmailConfirmed_x003E_k__BackingField>
  <_x003C_Email_x003E_k__BackingField>String</_x003C_Email_x003E_k__BackingField>
  <_x003C_Enabled_x003E_k__BackingField>false</_x003C_Enabled_x003E_k__BackingField>
  <_x003C_LastLogin_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastLogin_x003E_k__BackingField>
  <_x003C_MemberId_x003E_k__BackingField>0</_x003C_MemberId_x003E_k__BackingField>
  <_x003C_MobilePhoneConfirmed_x003E_k__BackingField>false</_x003C_MobilePhoneConfirmed_x003E_k__BackingField>
  <_x003C_MobilePhone_x003E_k__BackingField>String</_x003C_MobilePhone_x003E_k__BackingField>
  <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
  <_x003C_Notifications_x003E_k__BackingField>false</_x003C_Notifications_x003E_k__BackingField>
  <_x003C_ParentBranchId_x003E_k__BackingField>0</_x003C_ParentBranchId_x003E_k__BackingField>
  <_x003C_PasswordSalt_x003E_k__BackingField>String</_x003C_PasswordSalt_x003E_k__BackingField>
  <_x003C_Password_x003E_k__BackingField>String</_x003C_Password_x003E_k__BackingField>
  <_x003C_PublishableKey_x003E_k__BackingField>String</_x003C_PublishableKey_x003E_k__BackingField>
  <_x003C_Roles_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </_x003C_Roles_x003E_k__BackingField>
  <_x003C_SecretKey_x003E_k__BackingField>String</_x003C_SecretKey_x003E_k__BackingField>
  <_x003C_Training_x003E_k__BackingField>false</_x003C_Training_x003E_k__BackingField>
  <_x003C_TwoFactorEnabled_x003E_k__BackingField>false</_x003C_TwoFactorEnabled_x003E_k__BackingField>
  <_x003C_UserId_x003E_k__BackingField>0</_x003C_UserId_x003E_k__BackingField>
  <_x003C_UserName_x003E_k__BackingField>String</_x003C_UserName_x003E_k__BackingField>
</User>