| POST,GET | /api/Web/GetHeaderMenu |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Header | form | string | No | |
| HeaderMenuItems | form | List<HeaderMenuItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Url | form | string | No | |
| IsCurrent | form | bool | No | |
| Feature | form | Feature? | No | |
| HideFeature | form | bool | No | |
| Roles | form | string[] | No | |
| SubHeaderMenuItems | form | List<SubHeaderMenuItem> | No |
| Name | Value | |
|---|---|---|
| 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 | |
| NoBasketForBookings | 134217728 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Description | form | string | No | |
| Url | form | string | No | |
| Icon | form | string | No | |
| Roles | form | string[] | No | |
| Feature | form | Feature? | No | |
| HideForCMGo | form | bool? | No | |
| ShowFeatureUnavailable | form | bool | No | |
| HasIcon | form | bool | No | |
| HasFontAwesomeIcon | form | bool | No |
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
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: application/json
Content-Type: application/json
Content-Length: length
{"UserId":0,"MemberId":0}
HTTP/1.1 200 OK
Content-Type: application/json
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}]}]}