Enable Rules

Enable Rules for Banner.

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

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner doesn't exist.

Response sample:

200 OK

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.

Disable Rules

Disable Rules for Banner.

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

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner doesn't exist.

Response sample:
200 OK

  • 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.

Add Rule group

Adds new Rules group for Banner.

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

Error codes:

  • 400 – Empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner doesn't exist.

Response sample:
200 OK

  • 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.
  • ruleIds – array of Rules identifiers.
  • include – true if Rule should be included; false if Rule should be excluded.
  • operator – AND/OR operator.

Delete Rule group

Removes Rule group for Banner.

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

Error codes:

  • 400 – Empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner doesn't exist.

Response sample:
200 OK

  • 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.
  • ruleIds – array of Rules identifiers.

Return Rule groups

Returns all Rule groups for Banner.

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

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Banner doesn't exist.

Response sample:
200 OK

  • 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.

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.