YM REST Services

HelpTopic

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/HelpTopic/{HelpTopicID}	Return the details of Help Topic.

**HelpTopic** Parameters:
Name	Parameter	Data Type	Required	Description
HelpTopicID	path	string	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**HelpTopicResponse** Parameters:
Name	Parameter	Data Type	Required
HelpTopicID	form	string	No
HelpTopicBody	form	string	No
IsInternalAccount	form	bool	No
YAdminBaseURL	form	string	No

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}/HelpTopic/{HelpTopicID} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	HelpTopicID: String,
	HelpTopicBody: String,
	IsInternalAccount: False,
	YAdminBaseURL: String,
	UsingRedis: True,
	AppInitTime: 2025-01-15T05:46:19.7573927-05:00,
	ServerID: WS-4-27-804,
	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: 2025-01-15T08:40:29.3603537-05:00,
	Device: Desktop
}