Get fields' values

Get template fields' values by Banner ID.

URL: /rest-api/banner/{bannerId}.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – No Template for the given Banner.

Response sample:
200 OK

Method returns json formatted string with errors that occurred during execution. Format:
{"success":false, : } Example:
{"160″:"no_url_property_found","success":false}

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Template properties

Get the list of all Template properties required|supported by given Template.

URL: /rest-api/template/{templateId}/properties.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – No Template for the given Banner.

Response sample:
200 OK

[{"allowedContentTypes":"image/png","required":true,"key":"$$BANNER_SMALL$$"},
{"allowedContentTypes":"image/png","required":true,"key":"$$IMG_1$$"},
{"maxLength":255,"required":true,"url":false,"key":"$$LANDING_URL$$"}]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • templateId – the given Template ID.

Get all Templates

Get the list of all available Templates.

URL: /rest-api/template/list.do
Method: GET
Response format: application/json
Error codes:

  • 401 Unauthorized – authentication error.

Response sample:
200 OK

[{"id":1,"title":"Foo","propertiesCount":10,"placementType":"NON_STANDARD_SITE_PLACEMENT"},
{"id":2,"title":"Bar","propertiesCount":2,"placementType":"SITE_PLACEMENT"}]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.