YM REST Services

<back to all web services

CustomPageCrossLinks

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageCrossLinksReturn a custom page cross links to custom pages.
CustomPageCrossLinks Parameters:
NameParameterData TypeRequiredDescription
PageIDqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageCrossLinksResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageCrossLinksformList<CustomCrossLink>No
CustomCrossLink Parameters:
NameParameterData TypeRequiredDescription
PageIDformintNo
PageNameformstringNo
SelectedformboolNo

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.

GET /Ams/{ClientID}/CustomPageCrossLinks HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomPageCrossLinks: 
	[
		{
			PageID: 0,
			PageName: String,
			Selected: False
		}
	],
	PageID: 0,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T06:03:12.2081025-04:00,
	Device: Desktop
}