ClubManager.Api

<back to all web services

WebService.GetHeaderMenuRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Web/GetHeaderMenu
import java.math.*
import java.util.*
import net.servicestack.client.*


open class HeaderMenu
{
    var Header:String? = null
    var HeaderMenuItems:ArrayList<HeaderMenuItem> = ArrayList<HeaderMenuItem>()
}

open class HeaderMenuItem
{
    var Name:String? = null
    var Url:String? = null
    var IsCurrent:Boolean? = null
    var Feature:Feature? = null
    var HideFeature:Boolean? = null
    var Roles:ArrayList<String>? = null
    var SubHeaderMenuItems:ArrayList<SubHeaderMenuItem> = ArrayList<SubHeaderMenuItem>()
}

@Flags()
enum class Feature(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Standard(1),
    @SerializedName("2") Bookings(2),
    @SerializedName("4") Rota(4),
    @SerializedName("8") GoCardless(8),
    @SerializedName("16") HomeScreen(16),
    @SerializedName("32") EPos(32),
    @SerializedName("64") Attendance(64),
    @SerializedName("128") Sales(128),
    @SerializedName("256") PaymentCollections(256),
    @SerializedName("512") MailChimp(512),
    @SerializedName("1024") MultiSite(1024),
    @SerializedName("2048") AccountingDashboard(2048),
    @SerializedName("4096") OtherDashboards(4096),
    @SerializedName("8192") Reports(8192),
    @SerializedName("16384") AdvancedAccounting(16384),
    @SerializedName("32768") MemberLicenseDates(32768),
    @SerializedName("65536") FaceRecognition(65536),
    @SerializedName("131072") MemberAccountCreation(131072),
    @SerializedName("262144") Automation(262144),
    @SerializedName("524288") FacebookMarketing(524288),
    @SerializedName("1048576") Grades(1048576),
    @SerializedName("2097152") ZoomIntegration(2097152),
    @SerializedName("4194304") SalesTargetChart(4194304),
    @SerializedName("8388608") CustomApp(8388608),
    @SerializedName("16777216") CustomAttributesOnPortal(16777216),
    @SerializedName("33554432") NoExport(33554432),
    @SerializedName("67108864") EnterpriseClubPerformanceDashboards(67108864),
}

open class SubHeaderMenuItem
{
    var Name:String? = null
    var Description:String? = null
    var Url:String? = null
    var Icon:String? = null
    var Roles:ArrayList<String>? = null
    var Feature:Feature? = null
    var HideForCMGo:Boolean? = null
    var ShowFeatureUnavailable:Boolean? = null
    var HasIcon:Boolean? = null
    var HasFontAwesomeIcon:Boolean? = null
}

Kotlin WebService.GetHeaderMenuRequest DTOs

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/Web/GetHeaderMenu HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserId":0,"MemberId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Header":"String","HeaderMenuItems":[{"Name":"String","Url":"String","IsCurrent":false,"Feature":0,"HideFeature":false,"Roles":["String"],"SubHeaderMenuItems":[{"Name":"String","Description":"String","Url":"String","Icon":"String","Roles":["String"],"Feature":0,"HideForCMGo":false,"ShowFeatureUnavailable":false,"HasIcon":true,"HasFontAwesomeIcon":false}]}]}