ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchForAppRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranchForApp
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Interfaces.Models.Security

Namespace Global

    Namespace ClubManager.Interfaces.Models.Security

        <Flags>
        Public Enum TrainingCourse
            AddMember = 1
            EditMember = 2
            AddMembership = 4
            Journal = 8
            Home = 16
            Till = 32
            Accounting = 64
            UnexplainedPayments = 128
            Bookings = 256
            Users = 512
        End Enum

        Public Partial Class User
            Public Sub New()
                Roles = New String(){}
            End Sub

            Public Overridable Property UserId As Integer
            Public Overridable Property UserName As String
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property EmailConfirmed As Boolean
            Public Overridable Property MobilePhone As String
            Public Overridable Property MobilePhoneConfirmed As Boolean
            Public Overridable Property ConfirmPassword As String
            Public Overridable Property Password As String
            Public Overridable Property PasswordSalt As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property Training As Boolean
            Public Overridable Property LastLogin As Nullable(Of Date)
            Public Overridable Property Created As Date
            Public Overridable Property BranchId As Integer
            Public Overridable Property ParentBranchId As Integer
            Public Overridable Property MemberId As Nullable(Of Integer)
            Public Overridable Property Roles As String()
            Public Overridable Property CoursesCompleted As TrainingCourse
            Public Overridable Property DisplayHomeNotification As Boolean
            Public Overridable Property TwoFactorEnabled As Boolean
            Public Overridable Property BranchName As String
            Public Overridable Property BranchKey As Guid
            Public Overridable Property Notifications As Boolean
            Public Overridable Property PublishableKey As String
            Public Overridable Property SecretKey As String
            Public Overridable Property AppRegistrationId As String
            Public Overridable Property AppRegistrationLink As String
            Public Overridable Property AppQrImageLink As String
            Public Overridable Property ChangePassword As Nullable(Of Date)
            Public Overridable Property Activated As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET 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+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWojHxoa3GV5AyW+Nysed8+3TPEk+NjteK5AgqIKq06+VA=,
	AppRegistrationLink: "https://secure.clubmanagercentral.com/Register?id=7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWojHxoa3GV5AyW+Nysed8+3TPEk+NjteK5AgqIKq06+VA=",
	AppQrImageLink: "https://secure.clubmanagercentral.com/User.mvc/GetQrByUserId?id=36xZln01EfE80ZF7GFWKkg==",
	ChangePassword: 0001-01-01,
	Activated: 0001-01-01
}