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 .xml suffix or ?format=xml

HTTP + XML

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

<ContentAreaCustomMacrosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <CustomFieldMacroList>
    <CustomFieldMacro>
      <Code>String</Code>
      <Description>String</Description>
      <Label>String</Label>
    </CustomFieldMacro>
  </CustomFieldMacroList>
</ContentAreaCustomMacrosResponse>