Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

GBG Alert API Results (v5)

GBG Alert results will appear in a separate ‘gbgAlert’ section on the API result including the rule name and description. Details of the results are available here: Data Structures v5

API Examples (v5)

...

GBG Alert API Results (v1-v3)

GBG Alert results will appear in a similar way to watchlist results where:

  • If no configured GBG Alert rules are raised, the result will be ‘NOT_FOUND_ON_LIST’

  • If one or more configured GBG Alert rules are raised each rule will be listed with a ‘FOUND_ON_LIST’ result.

  • If a rule is triggered more than once, it will only be listed once.

  • If using the lockout functionality, an unlocked rules will not be displayed in the result but any new configured rules are raised after unlock, they will be displayed.

API Examples

...

...

Example: No GBG Alert Rules Raised

...

Image RemovedImage Added

Image RemovedImage Added

API Versions

Reference Tables V5

...