GetApplications Info API

  • Updated

GetApplications Info API

Description

This web service is used to get information about an application.

This takes an IDs parameter containing a list of Application IDs as values.

They return data corresponding to values mapped in the Custom template field of respective Data API Configuration object for applications.

It also takes in an optional ‘ExternalInvocationId’ parameter which is attached to the response. It is used by the external systems to maintain session information when they are requesting data in chunks.

Definition

POST https://<domain>/services/apexrest/intframework/q2-dataApi/applications

Authentication Type

Basic Salesforce Auth 2.0

See this link for SFDC Documentation: https://help.salesforce.com/articleView?id=remoteaccess_oauth_web_server_flow.htm&type=5

Parameters 

Request Header Parameters

The following table provides the details of the request header parameters used by this web service:

KeyValue
Content-Typeapplication/JSON
charsetUTF-8
Acceptapplication/JSON

Request Body Parameters

The following table provides the details of the request body parameters used by this web service:

Field NameType
Idsstring
ExternalInvocationIdsstring

Error Messages

When you use this web service you can receive the possible error messages as shown in the following table:

Status CodeError Messages
400

Request JSON is invalid.

400

Missing header in request - Content-type: application/JSON.

400

Missing parameter Ids in the request.

400Invalid values for parameter 'Ids' in the request.
400

invalid ID field: {0}

400

No Data API Configuration exists with name: {0}

400

No applications were found with Ids in the request.

404Not Found

Sample Request

The sample request to be sent is as shown in the following block:

Sample Request

{ "Ids": ["a6h5f000000Ck6cAAC", "a6h5f000000CjyHAAS", "a6h5f000000ChEHAA0", "a6h5f000000ChyJAAS"], "ExternalInvocationId": "bf96798e-0de6-11d0-a285-00aa003049e2" }

Sample Response

The sample response that you receive is as shown in the following block:

Sample Response
{
    "ExternalInvocationId": "bf96798e-0de6-11d0-a285-00aa003049e2",
    "data": {
        "applications": [
            {
                "productType": "LOAN",
                "assetClass": "Commercial Unsecured",
                "productId": "a0k5f0000003CG9AAM",
                "status": "NEW - ENTERED",
                "term": 36,
                "paymentFrequency": "MONTHLY",
                "openDate": "2021-09-21",
                "loanAmount": 100000.00,
                "creditLimit": 0.00,
                "firstPaymentDueDate": "2021-10-21",
                "interestRate": 0.0000,
                "maturityDate": "2024-09-21",
                "paymentAmount": 2777.78,
                "parties": [
                    {
                        "name": "Madonna Barry",
                        "accountId": "0015f000005Ge36AAC",
                        "relationshipToApplication": "BORROWER",
                        "email": {
                            "businessEmail": "bi-00001@test.com"                        }
                    }
                ]
            },
            {
                "productType": "LOAN",
                "assetClass": "Commercial Unsecured",
                "productId": "a0k5f0000003CG9AAM",
                "status": "NEW - ENTERED",
                "term": 36,
                "paymentFrequency": "MONTHLY",
                "openDate": "2021-09-21",
                "loanAmount": 100000.00,
                "firstPaymentDueDate": "2021-10-21",
                "interestRate": 0.0000,
                "paymentAmount": 2777.78
            },
            {
                "productType": "LOAN",
                "assetClass": "Commercial Unsecured",
                "productId": "a0k5f0000003CG9AAM",
                "status": "NEW - ENTERED",
                "term": 12,
                "paymentFrequency": "MONTHLY",
                "openDate": "2021-09-30",
                "loanAmount": 0.00,
                "creditLimit": 0.00,
                "firstPaymentDueDate": "2021-10-30",
                "interestRate": 0.0000,
                "maturityDate": "2022-09-30",
                "paymentAmount": 0.00,
                "parties": [
                    {
                        "name": "david bekham",
                        "accountId": "0015f000006nhwlAAA",
                        "relationshipToApplication": "BORROWER"                    },
                    {
                        "name": "party for david",
                        "contactId": "0035f000005GBhgAAG",
                        "accountId": "0015f000006nhwqAAA",
                        "relationshipToApplication": "CO-BORROWER"                    }
                ]
            },
            {
                "productType": "LOAN",
                "assetClass": "Commercial Unsecured",
                "productId": "a0k5f0000003CG9AAM",
                "status": "NEW - ENTERED",
                "term": 20,
                "paymentFrequency": "MONTHLY",
                "openDate": "2021-10-01",
                "loanAmount": 0.00,
                "creditLimit": 0.00,
                "firstPaymentDueDate": "2021-11-01",
                "interestRate": 0.0000,
                "maturityDate": "2023-06-01",
                "paymentAmount": 0.00,
                "parties": [
                    {
                        "name": "tata capital",
                        "accountId": "0015f000006o4nqAAA",
                        "relationshipToApplication": "BORROWER"                    }
                ]
            }
        ]
    }
}

In This Article