YM REST Services

<back to all web services

ContentAreaCustomMacros

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/ContentAreaCustomMacrosReturn a list of Custom field Macros for INVOICE_TEMPLATE.
ContentAreaCustomMacros Parameters:
NameParameterData TypeRequiredDescription
ContentAreaTypequerystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ContentAreaCustomMacrosResponse Parameters:
NameParameterData TypeRequiredDescription
CustomFieldMacroListformList<CustomFieldMacro>No
CustomFieldMacro Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
DescriptionformstringNo
CodeformstringNo

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}/ContentAreaCustomMacros HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CustomFieldMacroList: 
	[
		{
			Label: String,
			Description: String,
			Code: String
		}
	]
}