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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class User
    {
        public Integer UserId = null;
        public String UserName = null;
        public String Name = null;
        public String Email = null;
        public Boolean EmailConfirmed = null;
        public String MobilePhone = null;
        public Boolean MobilePhoneConfirmed = null;
        public String ConfirmPassword = null;
        public String Password = null;
        public String PasswordSalt = null;
        public Boolean Enabled = null;
        public Boolean Training = null;
        public Date LastLogin = null;
        public Date Created = null;
        public Integer BranchId = null;
        public Integer ParentBranchId = null;
        public Integer MemberId = null;
        public ArrayList<String> Roles = null;
        public TrainingCourse CoursesCompleted = null;
        public Boolean DisplayHomeNotification = null;
        public Boolean TwoFactorEnabled = null;
        public String BranchName = null;
        public UUID BranchKey = null;
        public Boolean Notifications = null;
        public String PublishableKey = null;
        public String SecretKey = null;
        public String AppRegistrationId = null;
        public String AppRegistrationLink = null;
        public String AppQrImageLink = null;
        public Date ChangePassword = null;
        public Date Activated = null;
        
        public Integer getUserId() { return UserId; }
        public User setUserId(Integer value) { this.UserId = value; return this; }
        public String getUserName() { return UserName; }
        public User setUserName(String value) { this.UserName = value; return this; }
        public String getName() { return Name; }
        public User setName(String value) { this.Name = value; return this; }
        public String getEmail() { return Email; }
        public User setEmail(String value) { this.Email = value; return this; }
        public Boolean isEmailConfirmed() { return EmailConfirmed; }
        public User setEmailConfirmed(Boolean value) { this.EmailConfirmed = value; return this; }
        public String getMobilePhone() { return MobilePhone; }
        public User setMobilePhone(String value) { this.MobilePhone = value; return this; }
        public Boolean isMobilePhoneConfirmed() { return MobilePhoneConfirmed; }
        public User setMobilePhoneConfirmed(Boolean value) { this.MobilePhoneConfirmed = value; return this; }
        public String getConfirmPassword() { return ConfirmPassword; }
        public User setConfirmPassword(String value) { this.ConfirmPassword = value; return this; }
        public String getPassword() { return Password; }
        public User setPassword(String value) { this.Password = value; return this; }
        public String getPasswordSalt() { return PasswordSalt; }
        public User setPasswordSalt(String value) { this.PasswordSalt = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public User setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Boolean isTraining() { return Training; }
        public User setTraining(Boolean value) { this.Training = value; return this; }
        public Date getLastLogin() { return LastLogin; }
        public User setLastLogin(Date value) { this.LastLogin = value; return this; }
        public Date getCreated() { return Created; }
        public User setCreated(Date value) { this.Created = value; return this; }
        public Integer getBranchId() { return BranchId; }
        public User setBranchId(Integer value) { this.BranchId = value; return this; }
        public Integer getParentBranchId() { return ParentBranchId; }
        public User setParentBranchId(Integer value) { this.ParentBranchId = value; return this; }
        public Integer getMemberId() { return MemberId; }
        public User setMemberId(Integer value) { this.MemberId = value; return this; }
        public ArrayList<String> getRoles() { return Roles; }
        public User setRoles(ArrayList<String> value) { this.Roles = value; return this; }
        public TrainingCourse getCoursesCompleted() { return CoursesCompleted; }
        public User setCoursesCompleted(TrainingCourse value) { this.CoursesCompleted = value; return this; }
        public Boolean isDisplayHomeNotification() { return DisplayHomeNotification; }
        public User setDisplayHomeNotification(Boolean value) { this.DisplayHomeNotification = value; return this; }
        public Boolean isTwoFactorEnabled() { return TwoFactorEnabled; }
        public User setTwoFactorEnabled(Boolean value) { this.TwoFactorEnabled = value; return this; }
        public String getBranchName() { return BranchName; }
        public User setBranchName(String value) { this.BranchName = value; return this; }
        public UUID getBranchKey() { return BranchKey; }
        public User setBranchKey(UUID value) { this.BranchKey = value; return this; }
        public Boolean isNotifications() { return Notifications; }
        public User setNotifications(Boolean value) { this.Notifications = value; return this; }
        public String getPublishableKey() { return PublishableKey; }
        public User setPublishableKey(String value) { this.PublishableKey = value; return this; }
        public String getSecretKey() { return SecretKey; }
        public User setSecretKey(String value) { this.SecretKey = value; return this; }
        public String getAppRegistrationId() { return AppRegistrationId; }
        public User setAppRegistrationId(String value) { this.AppRegistrationId = value; return this; }
        public String getAppRegistrationLink() { return AppRegistrationLink; }
        public User setAppRegistrationLink(String value) { this.AppRegistrationLink = value; return this; }
        public String getAppQrImageLink() { return AppQrImageLink; }
        public User setAppQrImageLink(String value) { this.AppQrImageLink = value; return this; }
        public Date getChangePassword() { return ChangePassword; }
        public User setChangePassword(Date value) { this.ChangePassword = value; return this; }
        public Date getActivated() { return Activated; }
        public User setActivated(Date value) { this.Activated = value; return this; }
    }

    @Flags()
    public static enum TrainingCourse
    {
        @SerializedName("1") AddMember(1),
        @SerializedName("2") EditMember(2),
        @SerializedName("4") AddMembership(4),
        @SerializedName("8") Journal(8),
        @SerializedName("16") Home(16),
        @SerializedName("32") Till(32),
        @SerializedName("64") Accounting(64),
        @SerializedName("128") UnexplainedPayments(128),
        @SerializedName("256") Bookings(256),
        @SerializedName("512") Users(512);

        private final int value;
        TrainingCourse(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java 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>