YM REST Services

<back to all web services

CustomPageTemplates

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CustomPageTemplatesReturn a list of custom page templates.
CustomPageTemplates Parameters:
NameParameterData TypeRequiredDescription
blnIncludeHiddenqueryboolNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CustomPageTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
CustomPageTemplatesformList<CustomPageTemplate>No
CustomPageTemplate Parameters:
NameParameterData TypeRequiredDescription
TemplateIDformintNo
TemplateNameformstringNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/CustomPageTemplates HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CustomPageTemplates":[{"TemplateID":0,"TemplateName":"String"}],"blnIncludeHidden":false,"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-03T03:41:46.0389337-04:00","Device":"Desktop"}