YM REST Services

<back to all web 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:
NameParameterData TypeRequiredDescription
HelpTopicIDpathstringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
HelpTopicResponse Parameters:
NameParameterData TypeRequiredDescription
HelpTopicIDformstringNo
HelpTopicBodyformstringNo
IsInternalAccountformboolNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"HelpTopicID":"String","HelpTopicBody":"String","IsInternalAccount":false,"UsingRedis":true,"AppInitTime":"2024-05-03T00:47:02.7459456-04:00","ServerID":"WS-4-7-585","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-03T01:16:46.3292700-04:00","Device":"Desktop"}