GetBorrowers Info API
Description
This web service is to get information about an application.
This takes an IDs parameter containing a list of Borrower IDs as values.
They return data corresponding to values mapped in the Custom template field of respective Data API Configuration object for borrowers.
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/borrowers
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:
| Key | Value |
|---|---|
| Content-Type | application/JSON |
| charset | UTF-8 |
| Accept | application/JSON |
Request Body Parameters
The following table provides the details of the request body parameters used by this web service:
| Field Name | Type |
|---|---|
| Ids | string |
| ExternalInvocationIds | string |
Error Messages
When you use this web service you can receive the possible error messages as shown in the following table:
| Status Code | Error Message |
|---|---|
| 400 | Request JSON is invalid |
| 400 | Missing header in request - Content-Type: application/JSON |
| 400 | Missing parameter Ids in the request. |
| 400 | Invalid values for parameter 'Ids' in the request. |
| 400 | invalid ID field: {0} |
| 400 | No Data API Configuration exists with name: {0} |
| 400 | No related applications were found with Ids in the request. |
| 404 | Not Found |
Sample Request
The sample request to be sent is as shown in the following block:
{
"Ids": ["a2m5f000000AhgaAAC"],
"ExternalInvocationId": "ad6798e-0de6-11d0-a285-00aa004549e2"}
Sample Response
The sample response that you receive is as shown in the following block:
{
"ExternalInvocationId": "ad6798e-0de6-11d0-a285-00aa004549e2",
"data": {
"borrowers": [
{
"legalEntityType": "Corporation",
"email": {
"businessEmail": "bi-00000@test.com" },
"taxId": "954337623",
"relatedApplications": [
{
"partyType": "BORROWER",
"applicationId": "a6h5f000000ChEMAA0" }
],
"accountId": "0015f000005EB4kAAG",
"address": [
{
"isCurrentAddress": false,
"isPreviousAddress": false,
"isBillingAddress": false,
"isShippingAddress": false,
"isMailingAddress": true,
"country": "US",
"zip": "848484",
"state": "NY",
"city": "NewYork",
"addressLine1": "312 Queens Palace" },
{
"isCurrentAddress": false,
"isPreviousAddress": false,
"isBillingAddress": true,
"isShippingAddress": false,
"isMailingAddress": false,
"country": "US",
"zip": "76767",
"state": "TX",
"city": "Austin",
"addressLine1": "312 Constitution Place" },
{
"isCurrentAddress": true,
"isPreviousAddress": false,
"isBillingAddress": false,
"isShippingAddress": false,
"isMailingAddress": false,
"country": "US",
"zip": "35209",
"state": "AL",
"city": "Birmingham",
"addressLine1": "228 SAXON" }
],
"name": "GORMAN &MANUFACTURING" }
]
}
}