ClubManager.Api

<back to all web services

SecurityService.GetUserByBranchRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Security/GetUserByBranch
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Flags()
class TrainingCourse(IntEnum):
    ADD_MEMBER = 1
    EDIT_MEMBER = 2
    ADD_MEMBERSHIP = 4
    JOURNAL = 8
    HOME = 16
    TILL = 32
    ACCOUNTING = 64
    UNEXPLAINED_PAYMENTS = 128
    BOOKINGS = 256
    USERS = 512


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class User:
    user_id: Optional[int] = None
    user_name: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    email_confirmed: Optional[bool] = None
    mobile_phone: Optional[str] = None
    mobile_phone_confirmed: Optional[bool] = None
    confirm_password: Optional[str] = None
    password: Optional[str] = None
    password_salt: Optional[str] = None
    enabled: Optional[bool] = None
    training: Optional[bool] = None
    last_login: Optional[datetime.datetime] = None
    created: Optional[datetime.datetime] = None
    branch_id: Optional[int] = None
    parent_branch_id: Optional[int] = None
    member_id: Optional[int] = None
    roles: Optional[List[str]] = None
    courses_completed: Optional[TrainingCourse] = None
    display_home_notification: Optional[bool] = None
    two_factor_enabled: Optional[bool] = None
    branch_name: Optional[str] = None
    branch_key: Optional[str] = None
    notifications: Optional[bool] = None
    publishable_key: Optional[str] = None
    secret_key: Optional[str] = None
    app_registration_id: Optional[str] = None
    app_registration_link: Optional[str] = None
    app_qr_image_link: Optional[str] = None
    change_password: Optional[datetime.datetime] = None
    activated: Optional[datetime.datetime] = None

Python SecurityService.GetUserByBranchRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
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+5MdrKWdOb3jcmCvVCNGhKIjNTe9jr4RPVK2J+4Vbg1pZ07GHSYpHfYxrvL6Lq3Ge8hls36UKcv0PfNE6c0eGIa57hbk=","AppRegistrationLink":"https://secure.clubmanagercentral.com/Register?id=7TvtgFvdvABkciG+5MdrKWdOb3jcmCvVCNGhKIjNTe9jr4RPVK2J+4Vbg1pZ07GHTCebgr6PrwJtGICzBVyZ5ETuRLUNVJkb0DwAjz8jP5Q=","AppQrImageLink":"https://secure.clubmanagercentral.com/User.mvc/GetQrByUserId?id=36xZln01EfE80ZF7GFWKkg==","ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"}