ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchForAppRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranchForApp

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

export class User
{
    public UserId?: number;
    public UserName?: string;
    public Name?: string;
    public Email?: string;
    public EmailConfirmed?: boolean;
    public MobilePhone?: string;
    public MobilePhoneConfirmed?: boolean;
    public ConfirmPassword?: string;
    public Password?: string;
    public PasswordSalt?: string;
    public Enabled?: boolean;
    public Training?: boolean;
    public LastLogin?: string;
    public Created?: string;
    public BranchId?: number;
    public ParentBranchId?: number;
    public MemberId?: number;
    public Roles?: string[];
    public CoursesCompleted?: TrainingCourse;
    public DisplayHomeNotification?: boolean;
    public TwoFactorEnabled?: boolean;
    public BranchName?: string;
    public BranchKey?: string;
    public Notifications?: boolean;
    public PublishableKey?: string;
    public SecretKey?: string;
    public AppRegistrationId?: string;
    public AppRegistrationLink?: string;
    public AppQrImageLink?: string;
    public ChangePassword?: string;
    public Activated?: string;

    public constructor(init?: Partial<User>) { (Object as any).assign(this, init); }
}

TypeScript SecurityService.GetUserByBranchForAppRequest 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/GetUserByBranchForApp HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SecurityService.GetUserByBranchForAppRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services">
  <AppUserId>0</AppUserId>
</SecurityService.GetUserByBranchForAppRequest>
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>