Queries

AlertDetailsQuery

class q2_cores.Corelation.queries.alert_details_query.AlertDetailsQuery(logger, target_serials)

Bases: BaseQuery

Gets details about user alerts

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get details about user alerts

Example query:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <recordTree>
                    <tableName>ALERT_ENROLLMENT</tableName>
                    <targetSerial>5</targetSerial>
                    <includeRecordDetail option="Y"/>
                    <recordDetail>
                        <tableName>ALERT_ENROLLMENT</tableName>
                    </recordDetail>
                    <recordDetail>
                        <tableName>ALERT_ENROLLMENT_CONTACT</tableName>
                    </recordDetail>
                </recordTree>
            </step>
        </transaction>
    </sequence>
    <sequence>
        <transaction>
            <step>
                <recordTree>
                    <tableName>ALERT_ENROLLMENT</tableName>
                    <targetSerial>6</targetSerial>
                    <includeRecordDetail option="Y"/>
                    <recordDetail>
                        <tableName>ALERT_ENROLLMENT</tableName>
                    </recordDetail>
                    <recordDetail>
                        <tableName>ALERT_ENROLLMENT_CONTACT</tableName>
                    </recordDetail>
                </recordTree>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

AlertTypeDetailsQuery

class q2_cores.Corelation.queries.alert_type_details_query.AlertTypeDetailsQuery(logger, target_serials)

Bases: BaseQuery

Gets details for one or more alerts by serial

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get details about alerts

Example query:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <record>
                    <operation option="V"/>
                    <includeRowDescriptions option="Y"/>
                    <includeAllColumns option="Y"/>
                    <tableName>ALERT_TYPE</tableName>
                    <targetSerial>2</targetSerial>
                </record>
            </step>
        </transaction>
    </sequence>
    <sequence>
        <transaction>
            <step>
                <record>
                    <operation option="V"/>
                    <includeRowDescriptions option="Y"/>
                    <includeAllColumns option="Y"/>
                    <tableName>ALERT_TYPE</tableName>
                    <targetSerial>5</targetSerial>
                </record>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

AlertTypesQuery

class q2_cores.Corelation.queries.alert_types_query.AlertTypesQuery(logger)

Bases: BaseQuery

Gets the FI’s available alert types

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get all available alert types

Example query:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <search>
                    <tableName>ALERT_TYPE</tableName>
                    <filterName>BY_DESCRIPTION</filterName>
                    <includeSelectColumns option="Y"/>
                    <includeTotalHitCount option="Y"/>
                    <returnLimit>1000</returnLimit>
                    <parameter>
                        <columnName>DESCRIPTION</columnName>
                        <contents></contents>
                    </parameter>
                </search>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

AlertsByPersonSerialQuery

class q2_cores.Corelation.queries.alerts_by_person_serial_query.AlertsByPersonSerialQuery(logger, person_serial)

Bases: BaseQuery

Gets user alerts

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get user’s alerts

Example query:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <search>
                    <tableName>ALERT_ENROLLMENT</tableName>
                    <filterName>BY_PERSON_SERIAL</filterName>
                    <includeSelectColumns option="Y"/>
                    <includeTotalHitCount option="Y"/>
                    <returnLimit>500</returnLimit>
                    <parameter>
                        <columnName>PERSON_SERIAL</columnName>
                        <contents>58578</contents>
                    </parameter>
                </search>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

DemographicInfoQuery

class q2_cores.Corelation.queries.demographic_info_query.DemographicInfoQuery(logger, person_serial=None, req_dict=None, search_type=SearchType.LOGIN_VERIFY)

Bases: BaseQuery

Builds the payload for the demographic call to the Corelation Core. Options to search include: login verification or person verification method

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get demographic info.

Example query to search using login verification:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <search>
                    <tableName>PERSON</tableName>
                    <filterName>BY_SERIAL</filterName>
                    <formatName>VERIFICATION</formatName>
                    <includeTotalHitCount option="Y"/>
                    <returnLimit>10</returnLimit>
                    <parameter>
                        <columnName>SERIAL</columnName>
                        <contents>36323</contents>
                    </parameter>
                </search>
            </step>
        </transaction>
    </sequence>
</query>

Example query to search using person verification:

This person verification call with TIN will help to get the personal serial associated with the TIN even if login record is not setup in keystone

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <search>
                    <tableName>PERSON</tableName>
                    <filterName>BY_TIN</filterName>
                    <parameter>
                        <columnName>TIN</columnName>
                        <contents>123456789</contents>
                    </parameter>
                    <formatName>VERIFICATION</formatName>
                    <includeTotalHitCount option="Y"/>
                    <returnLimit>50</returnLimit>
                    <includeSelectColumns option="N"/>
                </search>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

LoginVerifyQuery

class q2_cores.Corelation.queries.login_verify_query.LoginVerifyQuery(logger, member_number, channel_serial)

Bases: BaseQuery

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

• logger (Logger) – Reference to calling request’s logger (self.logger in your extension)

• mock_failure – If server is running in debug mode, will be used while mocking the response

build()

Creates query to get a Person, Account, and/or Login serial from SSN or CIF

Example query:

<query xmlns="http://www.corelationinc.com/queryLanguage/v1.0">
    <sequence>
        <transaction>
            <step>
                <loginVerify>
                    <channelSerial>1</channelSerial>
                    <loginId>111223333</loginId>
                </loginVerify>
            </step>
        </transaction>
    </sequence>
</query>

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

MockResponses

q2_cores.Corelation.queries.mock_responses.alert_details_response()

q2_cores.Corelation.queries.mock_responses.alert_type_details_response()

q2_cores.Corelation.queries.mock_responses.alert_types_response()

q2_cores.Corelation.queries.mock_responses.alerts_by_person_serial_response()

q2_cores.Corelation.queries.mock_responses.demographic_info_response()

q2_cores.Corelation.queries.mock_responses.login_verify_response()

q2_cores.Corelation.queries.mock_responses.mock_person_verification_response()

q2_cores.Corelation.queries.mock_responses.mock_invalid_account_number_response()