APModuleTool

Tool module

Access all of the API endpoints under the 'tool' path. Each module is loaded via {@link \APAPI\APLoader} and passed a reference to a {@link \APAPI\APAPI} instance to use. In practice, usage of SDK modules is as simple as:

$api->tool->initialize();

see

Methods

Constructor

__construct($pxAPIOb)

When a module is requested via the API base class, it is automatically passed a reference to a {@link \APAPI\APAPI} instance to use.

Arguments

$pxAPIOb

getTCN - GET tcn

getTCN() : mixed

Get the current TCN Loan list.

Response

mixed

getTCNTemplates - GET tcn/templates

getTCNTemplates() : mixed

Get the TCN templates available to the current instance.

Response

mixed

getUser - GET tcn/user

getUser(string $loanId, string $tool, string $expand = '') : mixed

Run one of the user tools against a loan's borrower and coborrower.

Arguments

$loanId

string

ID of the loan associated to the borrower

$tool

string

User tool to run

$expand

string

Other tool options

Response

mixed

postTCN - POST tool/tcn

postTCN(array $data) : mixed

Add the specified loan to TCN telephone campaign. The current user must have a TCN account already set up and with good standing with TCN.

Arguments

$data

array

TCN data

Response

mixed

postTCNInitiate - POST tool/tcn/initiate

postTCNInitiate(array $data) : mixed

Initiate a TCN campaign for the current loan list.

Arguments

$data

array

TCN tool data

Response

mixed

postCollectorQueue - POST tool/collectorqueue

postCollectorQueue(array $data) : mixed

Add the specified loan to the collector queue.

Arguments

$data

array

Array with the loan ID to add to the collector queue

Response

mixed

postEmailRecipients - POST tcn/emailrecipients

postEmailRecipients(array $data) : mixed

Add the specified loan to the list of email recipients.

Arguments

$data

array

Array with the loan ID to add to the list of email recipients

Response

mixed

Properties

api

api