Skip to main content

Get Templates by Field

This method retrieves a list of Transactional Messaging Templates containing a given value in a specified field.

This is a GET method.

REST WADL

https://atmp-pub-api-www3.actito.com/apitransactional/services/rest?_wadl&_type=xml

REST URL

https://atmp-pub-api-www3.actito.com/apitransactional/services/rest/template/getByField/{token}/{type]/{field}/{value}/{limit}

| Input parameters
Required parameters | Description | Output parameters | Description | | ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- | | token | The connection token | return | The list of Template IDs | | type | The type of Template:

  • TRANSACTIONAL
  • SOCIALNETWORK (this value is deprecated)
| | | | field | The field to update
  • name
  • description
  • subject
  • from
  • to
  • replyTo
  • replyToEmail
  • encoding
| | | | value | The value to set for the field | | | | limit | The maximum number of Templates to retrieve | | |

Error messages​

  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)
  • (missing or bad snippet)

REST Example​

Input​

https://atmp-pub-api-www3.actito.com/apitransactional/services/rest/template/getByField/{token}/TRANSACTIONAL/name/Template/5

Output​

<response responseStatus="success">
  <entities>
    <id>178</id>
    <id>176</id>
    <id>175</id>
    <id>173</id>
    <id>171</id>
  </entities>
</response>