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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AppUserId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UserId: 0,
	UserName: String,
	Name: String,
	Email: String,
	EmailConfirmed: False,
	MobilePhone: String,
	MobilePhoneConfirmed: False,
	ConfirmPassword: String,
	Password: String,
	PasswordSalt: String,
	Enabled: False,
	Training: False,
	LastLogin: 0001-01-01,
	Created: 0001-01-01,
	BranchId: 0,
	ParentBranchId: 0,
	MemberId: 0,
	Roles: 
	[
		String
	],
	CoursesCompleted: 1,
	DisplayHomeNotification: False,
	TwoFactorEnabled: False,
	BranchName: String,
	BranchKey: 00000000000000000000000000000000,
	Notifications: False,
	PublishableKey: String,
	SecretKey: String,
	AppRegistrationId: 7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWoHxtp9wGg81fZ5GibFSLDD2+UuBAokBPHlO4ssecYRZc=,
	AppRegistrationLink: "https://secure.clubmanagercentral.com/Register?id=7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWoHxtp9wGg81fZ5GibFSLDD2+UuBAokBPHlO4ssecYRZc=",
	AppQrImageLink: "https://secure.clubmanagercentral.com/User.mvc/GetQrByUserId?id=36xZln01EfE80ZF7GFWKkg==",
	ChangePassword: 0001-01-01,
	Activated: 0001-01-01
}