Guides

General Search

Contact and Loan search combine in one endpoint

Suggest Edits

Nortridge API also offers a single endpoint to search for either contact or loan records, POST /search. This will be quite useful in situations where you plan to have a single, all-purpose, search field. The result will be contacts or loans that match the user input string.

The search is done by passing a JSON payload through the API request parameter, searchParam.
Only one JSON attribute is used for searchParam:

{
  "SearchString": "string"
}

📘

Contact and Loan returned attributes

The expected attributes will follow the same format as POST /loans/search and POST /contacts/search

Postman Example

If you imported the Swagger into Postman, POST /search/ request will already be configured for you. In this example we will be using the search string, general.

Request Header

Content-Type needs to be set to application/json.

967

Request Body

The JSON script will go in the request body. Set the request type to Raw and format to JSON.

964

🚧

Auth Token

Make sure there is an authorized token before sending the request.
[Check out how to get an access token] (https://apidocs.nortridge.com/docs/get-access-token).

📘

Limit your results

Too broad of a search may result in many contact and loan records being returned. You may limit your results with request Query Parameters. Check out POST /search.

Click on Send when you are ready to execute this request. The API will return with a status 200 indicating that the request is valid.

In the below example my search string is general. In my NLS database I have a contact named General George and loan number, General Loan. This is what's expected from the search results:

964 
{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "data": {
            "Contacts": [
                {
                    "Cifno": 10128,
                    "Cifnumber": "G1",
                    "Shortname": null,
                    "Company": null,
                    "Firstname1": "GENERAL",
                    "Middlename1": null,
                    "Lastname1": "GEORGE",
                    "Firstname2": null,
                    "Middlename2": null,
                    "Lastname2": null,
                    "Branch_Cifno": 53,
                    "Portfolio_Code_Id": 0,
                    "Address_Type": 0,
                    "Street_Address1": "123 STREET ST",
                    "Street_Address2": null,
                    "City": "TUSTIN ",
                    "State": "CA",
                    "Zip": "92780",
                    "Entity": "INDIVIDUAL"
                }
            ],
            "Loans": [
                {
                    "Acctrefno": 10647,
                    "Loan_Type": 0,
                    "Portfolio_Code_Id": 0,
                    "Loan_Number": "GENERAL LOAN",
                    "Cifno": 2,
                    "Loan_Group_No": 1,
                    "Shortname": "HARPER LEE",
                    "Name": "LEE HARPER ",
                    "Loan_Class1_No": 0,
                    "Loan_Class2_No": 0,
                    "Risk_Rating_No": 0,
                    "Entity": "INDIVIDUAL",
                    "Branch_Cifno": null,
                    "Status_Code_No": 0,
                    "Loan_Officer_No": 0,
                    "Collection_Officer_No": 0,
                    "Dealer_Cifno": null,
                    "Master_Acctrefno": 0,
                    "Pool_Acctrefno": 0,
                    "Shadow_Loan_Exists": false,
                    "Curr_Maturity_Date": "2022-12-23T00:00:00",
                    "Interest_Accrued_Thru_Date": "2022-02-16T00:00:00",
                    "Current_Note_Amount": 100.00,
                    "Current_Payoff_Balance": 90.9665753440,
                    "Days_Past_Due": 24,
                    "Closed_Date": null
                }
            ]
        }
    }
}

Use Case: NLS Web Client

NLS Web Client has a general search bar that leverages this endpoint for an all-in-one search solution.

626 587

Updated almost 3 years ago