ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranch
User Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
NameformstringNo
EmailformstringNo
EmailConfirmedformboolNo
MobilePhoneformstringNo
MobilePhoneConfirmedformboolNo
ConfirmPasswordformstringNo
PasswordformstringNo
PasswordSaltformstringNo
EnabledformboolNo
TrainingformboolNo
LastLoginformDateTime?No
CreatedformDateTimeNo
BranchIdformintNo
ParentBranchIdformintNo
MemberIdformint?No
Rolesformstring[]No
CoursesCompletedformTrainingCourseNo
DisplayHomeNotificationformboolNo
TwoFactorEnabledformboolNo
BranchNameformstringNo
BranchKeyformGuidNo
NotificationsformboolNo
PublishableKeyformstringNo
SecretKeyformstringNo
AppRegistrationIdformstringNo
AppRegistrationLinkformstringNo
ChangePasswordformDateTime?No
ActivatedformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

{}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","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+5MdrKWdOb3jcmCvVCNGhKIjNTe+m7Bzfn29HJBQlxJgcOSPZZ4QcrJmYGFn/xYGU1y/AtfuUXp2uKDsthmWapv/OeFQ=","AppRegistrationLink":"https://secure.clubmanagercentral.com/Register?id=7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe+m7Bzfn29HJBQlxJgcOSPZZ4QcrJmYGFn/xYGU1y/AtfuUXp2uKDsthmWapv/OeFQ=","ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"}