ClubManager.Api

<back to all web services

WebService.GetHeaderMenuRequest

Requires Authentication
The following routes are available for this service:
POST,GET/api/Web/GetHeaderMenu
HeaderMenu Parameters:
NameParameterData TypeRequiredDescription
HeaderformstringNo
HeaderMenuItemsformList<HeaderMenuItem>No
HeaderMenuItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UrlformstringNo
IsCurrentformboolNo
FeatureformFeature?No
HideFeatureformboolNo
Rolesformstring[]No
SubHeaderMenuItemsformList<SubHeaderMenuItem>No
SubHeaderMenuItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
UrlformstringNo
IconformstringNo
Rolesformstring[]No
FeatureformFeature?No
HideForCMGoformbool?No
ShowFeatureUnavailableformboolNo
HasIconformboolNo
HasFontAwesomeIconformboolNo

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserId: 0,
	MemberId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
				}
			]
		}
	]
}