Versions Compared

Old Version 2

changes.mady.by.user Sharmeen Hussain

Saved on

compared with

New Version 3

changes.mady.by.user Sharmeen Hussain

Saved on

Key

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

...

The HTML fragment is the result of the most basic strategy for taking the input fields, as listed in the fieldList element, and transforming them into HTML.  The customer is free to use this HTML fragment, or ignore it.


Interpreting

...

gbgAlert

A call to any method in the greenID API will return, as part of the CurrentStatusV5 object, a gbgAlert element.  The gbgAlert contain the results of the GBG Alert evaluations.


If the overall status is NOT_ATTEMPTED then the gbgAlert  element will contain no other data.  For example:



<gbgAlert>
    <overallAlertStatus>NOT_ATTEMPTED</overallGreenIDAlertStatus>
</gbgAlert>



If the overall status is NO_ALERT_RAISED, the gbgAlert element may, or may not, contain 'raisedAlerts'. This is because NO_ALERT_RAISED can mean:


  1. No alerts have ever been raised OR
  2. There were alerts raised and locked, but an administrator has 'unlocked' them all - therefore there are no unactioned/of concern Alerts raised.



<gbgAlert>
    <overallAlertStatus>NO_ALERT_RAISED</overallGreenIDAlertStatus>
</gbgAlert>





If the overall status is ALERTS_RAISED, then the top-level element will contain the overall Alert status, as well as a score (see note below) and a list of 'raisedAlerts' (i.e.  configured rules which have been triggered.. The 'raisedAlerts' will contain a list of 'raisedAlert' elements, each containing information about an alert rule raised.


For example:



<gbgAlert>
    <raisedAlerts>
        <raisedAlert>
            <alertRule>Rule A2</alertRule>
            <description>Persona used at a telco in the last 96 hours and, multiple (2+) banks, in the last 24 hours</description>
            <firstRaised>2022-08-30T13:36:22.172+1000</firstRaised>
            <multipleInstances>true</multipleInstances>
            <alertRuleStatus>UNLOCKED</alertRuleStatus>
            <extraData>
               <name>attribute1</name>
               <value>An important value about this raised alert</value>
            </extraData>
            <extraData>
               <name>attribute2</name>
               <value>Another important value about this raised alert</value>            
            </extraData>
        </raisedAlert>
        <raisedAlert>
            <alertRule>Rule B1</alertRule>
            <description>Mobile phone used with this Persona has been associated with another Persona in the last 365 days</description>
            <firstRaised>2022-08-30T13:36:24.172+1000</firstRaised>
            <multipleInstances>false</multipleInstances>
            <alertRuleStatus>LOCKED</alertRuleStatus>
        </raisedAlert>
    </raisedAlerts>
    <overallAlertStatus>ALERT_RAISED</overallAlertStatus>
</gbgAlert>