Skip to main content

Get Dynamic Content Blocks by Field

This method retrieves a list of Dynamic Content Blocks that contain the same given value in a specific 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/banner/getByField/{token}/{field}/{value}/{limit}

| Input parameters
Required parameters | Description | Output parameters | Description | | ----------------------------------------------------------------------------- | ----------- | ----------------- | ----------- | | token | The connection token | return | listIds - The list of Dynamic Content Block IDs | | field | The field of the Dynamic Content Block:

  • name
  • description
  • contentType
| | | | value | The value of the field

Required for:
  • the name field
  • the contentType field (0=TEXT, 1=HTML)

Optional for:
  • the description field
| | | | limit | The size of the list (between 1 and 1000) | | |

Error messages​

  • You must fill in the token parameter
  • You must fill in the field parameter.
  • You must fill in the limit parameter.
  • You must fill in the name parameter.
  • You must fill in the contentType parameter.
  • An error occured on the server

REST Example​

Input​

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

Output​

<response responseStatus="success">
  <entities>
    <id>150</id>
    <id>151</id>
    <id>152</id>
  </entities>
</response>