| POST,GET | /api/Web/GetHeaderMenu |
|---|
// @Flags()
export enum Feature
{
None = 0,
Standard = 1,
Bookings = 2,
Rota = 4,
GoCardless = 8,
HomeScreen = 16,
EPos = 32,
Attendance = 64,
Sales = 128,
PaymentCollections = 256,
MailChimp = 512,
MultiSite = 1024,
AccountingDashboard = 2048,
OtherDashboards = 4096,
Reports = 8192,
AdvancedAccounting = 16384,
MemberLicenseDates = 32768,
FaceRecognition = 65536,
MemberAccountCreation = 131072,
Automation = 262144,
FacebookMarketing = 524288,
Grades = 1048576,
ZoomIntegration = 2097152,
SalesTargetChart = 4194304,
CustomApp = 8388608,
CustomAttributesOnPortal = 16777216,
NoExport = 33554432,
EnterpriseClubPerformanceDashboards = 67108864,
}
export class SubHeaderMenuItem
{
public Name?: string;
public Description?: string;
public Url?: string;
public Icon?: string;
public Roles?: string[];
public Feature?: Feature;
public HideForCMGo?: boolean;
public ShowFeatureUnavailable?: boolean;
public HasIcon?: boolean;
public HasFontAwesomeIcon?: boolean;
public constructor(init?: Partial<SubHeaderMenuItem>) { (Object as any).assign(this, init); }
}
export class HeaderMenuItem
{
public Name?: string;
public Url?: string;
public IsCurrent?: boolean;
public Feature?: Feature;
public HideFeature?: boolean;
public Roles?: string[];
public SubHeaderMenuItems?: SubHeaderMenuItem[];
public constructor(init?: Partial<HeaderMenuItem>) { (Object as any).assign(this, init); }
}
export class HeaderMenu
{
public Header?: string;
public HeaderMenuItems?: HeaderMenuItem[];
public constructor(init?: Partial<HeaderMenu>) { (Object as any).assign(this, init); }
}
TypeScript WebService.GetHeaderMenuRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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}]}]}