ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranch
namespace ClubManager.Interfaces.Models.Security

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<Flags>]
    type TrainingCourse =
        | AddMember = 1
        | EditMember = 2
        | AddMembership = 4
        | Journal = 8
        | Home = 16
        | Till = 32
        | Accounting = 64
        | UnexplainedPayments = 128
        | Bookings = 256
        | Users = 512

    [<AllowNullLiteral>]
    type User() = 
        member val UserId:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhone:String = null with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val ConfirmPassword:String = null with get,set
        member val Password:String = null with get,set
        member val PasswordSalt:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val BranchId:Int32 = new Int32() with get,set
        member val ParentBranchId:Int32 = new Int32() with get,set
        member val MemberId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Roles:String[] = [||] with get,set
        member val CoursesCompleted:TrainingCourse = new TrainingCourse() with get,set
        member val DisplayHomeNotification:Boolean = new Boolean() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val BranchName:String = null with get,set
        member val BranchKey:Guid = new Guid() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val PublishableKey:String = null with get,set
        member val SecretKey:String = null with get,set
        member val AppRegistrationId:String = null with get,set
        member val AppRegistrationLink:String = null with get,set
        member val AppQrImageLink:String = null with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# SecurityService.GetUserByBranchRequest 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/GetUserByBranch HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
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+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWotlKmMF/Vozd4UpmaSDjfBo6a9WvaOUfSpIHmilH4xMQ=,
	AppRegistrationLink: "https://secure.clubmanagercentral.com/Register?id=7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe8DO9SIT6XiKiD7kcMEPEWotlKmMF/Vozd4UpmaSDjfBo6a9WvaOUfSpIHmilH4xMQ=",
	AppQrImageLink: "https://secure.clubmanagercentral.com/User.mvc/GetQrByUserId?id=36xZln01EfE80ZF7GFWKkg==",
	ChangePassword: 0001-01-01,
	Activated: 0001-01-01
}