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.*;

public class dtos
{

    public static class HeaderMenu
    {
        public String Header = null;
        public ArrayList<HeaderMenuItem> HeaderMenuItems = null;
        
        public String getHeader() { return Header; }
        public HeaderMenu setHeader(String value) { this.Header = value; return this; }
        public ArrayList<HeaderMenuItem> getHeaderMenuItems() { return HeaderMenuItems; }
        public HeaderMenu setHeaderMenuItems(ArrayList<HeaderMenuItem> value) { this.HeaderMenuItems = value; return this; }
    }

    public static class HeaderMenuItem
    {
        public String Name = null;
        public String Url = null;
        public Boolean IsCurrent = null;
        public Feature Feature = null;
        public Boolean HideFeature = null;
        public ArrayList<String> Roles = null;
        public ArrayList<SubHeaderMenuItem> SubHeaderMenuItems = null;
        
        public String getName() { return Name; }
        public HeaderMenuItem setName(String value) { this.Name = value; return this; }
        public String getUrl() { return Url; }
        public HeaderMenuItem setUrl(String value) { this.Url = value; return this; }
        public Boolean getIsCurrent() { return IsCurrent; }
        public HeaderMenuItem setIsCurrent(Boolean value) { this.IsCurrent = value; return this; }
        public Feature getFeature() { return Feature; }
        public HeaderMenuItem setFeature(Feature value) { this.Feature = value; return this; }
        public Boolean isHideFeature() { return HideFeature; }
        public HeaderMenuItem setHideFeature(Boolean value) { this.HideFeature = value; return this; }
        public ArrayList<String> getRoles() { return Roles; }
        public HeaderMenuItem setRoles(ArrayList<String> value) { this.Roles = value; return this; }
        public ArrayList<SubHeaderMenuItem> getSubHeaderMenuItems() { return SubHeaderMenuItems; }
        public HeaderMenuItem setSubHeaderMenuItems(ArrayList<SubHeaderMenuItem> value) { this.SubHeaderMenuItems = value; return this; }
    }

    @Flags()
    public static enum Feature
    {
        @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);

        private final int value;
        Feature(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class SubHeaderMenuItem
    {
        public String Name = null;
        public String Description = null;
        public String Url = null;
        public String Icon = null;
        public ArrayList<String> Roles = null;
        public Feature Feature = null;
        public Boolean HideForCMGo = null;
        public Boolean ShowFeatureUnavailable = null;
        public Boolean HasIcon = null;
        public Boolean HasFontAwesomeIcon = null;
        
        public String getName() { return Name; }
        public SubHeaderMenuItem setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public SubHeaderMenuItem setDescription(String value) { this.Description = value; return this; }
        public String getUrl() { return Url; }
        public SubHeaderMenuItem setUrl(String value) { this.Url = value; return this; }
        public String getIcon() { return Icon; }
        public SubHeaderMenuItem setIcon(String value) { this.Icon = value; return this; }
        public ArrayList<String> getRoles() { return Roles; }
        public SubHeaderMenuItem setRoles(ArrayList<String> value) { this.Roles = value; return this; }
        public Feature getFeature() { return Feature; }
        public SubHeaderMenuItem setFeature(Feature value) { this.Feature = value; return this; }
        public Boolean isHideForCMGo() { return HideForCMGo; }
        public SubHeaderMenuItem setHideForCMGo(Boolean value) { this.HideForCMGo = value; return this; }
        public Boolean isShowFeatureUnavailable() { return ShowFeatureUnavailable; }
        public SubHeaderMenuItem setShowFeatureUnavailable(Boolean value) { this.ShowFeatureUnavailable = value; return this; }
        public Boolean isHasIcon() { return HasIcon; }
        public SubHeaderMenuItem setHasIcon(Boolean value) { this.HasIcon = value; return this; }
        public Boolean isHasFontAwesomeIcon() { return HasFontAwesomeIcon; }
        public SubHeaderMenuItem setHasFontAwesomeIcon(Boolean value) { this.HasFontAwesomeIcon = value; return this; }
    }

}

Java 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}]}]}