Retrieve an Application (V1)
Description
This web service returns all the applications that belong to a borrower, account, contract, or to all the applications present in the system.
Definition
GET https://<domain>/services/apexrest/genesis/v1/applications/*
Parameters
The following table provides details of the request parameters used by this web service:
| Field | Type | Description |
|---|---|---|
| productType* | String |
|
| accounttId | String |
|
| contactId | String |
|
| status | String |
|
| startDate | Date |
|
| endDate | Date |
|
Error Messages
When you use this web service you can receive the possible error messages as shown in the following table:
| Error Code | Error Message | System.Label | Reason | HTTP Status Code |
|---|---|---|---|---|
| INVALID_INPUT | Product Type is null | PRODUCT_TYPE_NULL | You will receive this error if the Product Type is not specified in the Request Parameters. | 400 |
| INVALID_INPUT | Unable to find the Product Type | PRODUCT_TYPE_NOT_FOUND | You will receive this error if the Product Type specified in the Request Parameters is invalid. | 400 |
| INVALID_INPUT | Unable to find the Account | ACCOUNT_NOT_FOUND | You will receive this error if no record exists in the system for the Borrower Account ID (borrowerId) specified in the Request Parameters. | 400 |
| INVALID_INPUT | Unable to find the Contact | CONTACT_NOT_FOUND | You will receive this error if no record exists in the system for the Contact ID (contactId) specified in the Request Parameters. | 400 |
| API_EXCEPTION | <exception_message> | NA | You will receive this error if any validation fails or any unexpected error occurs during the processing of the request, the system will raise the exception. | 500 |
Sample Request
The sample request to be sent is as shown below:
GET https://na10.salesforce.com/services/apexrest/genesis/v1/applications?productType=Lease
Sample Response
This sample response contains the loan applications for the given product type. The sample response that you will receive is as shown below:
{
"status": "SUCCESS",
"response": [],
"errorMessage": null,
"errorCode": "NO_ERROR",
"content": [
{
"attributes": {
"type": "genesis__Applications__c",
"url": "/services/data/v32.0/sobjects/genesis__Applications__c/a39F0000000IVs5IAG"
},
"genesis__Is_over_21__c": false,
"genesis__Quick_Quote__c": "a02F000000AWRXLIA5",
"RecordTypeId": "012F00000012dIOIAY",
"genesis__Product_Type__c": "LEASE",
"genesis__Estimated_Selling_Price__c": 5000,
"genesis__Payable_To_Dealer__c": 5000,
"genesis__Additional_Cash_Required__c": 800,
"OwnerId": "005F0000002i99wIAA",
"genesis__Payment_Frequency__c": "MONTHLY",
"genesis__Valid_Pricing_Flag__c": false,
"LastModifiedDate": "2014-05-21T11:33:19.000+0000",
"genesis__Other_Financed_fees__c": 0,
"genesis__Credit_Review__c": false,
"genesis__Company__c": "a1uF00000001YMMIA2",
"genesis__Total_Dealer_Price__c": 5000,
"SystemModstamp": "2015-01-25T16:13:27.000+0000",
"genesis__Tax_Amount__c": 0,
"genesis__Expected_Start_Date__c": "2014-05-13",
"genesis__Status__c": "NEW - ENTERED",
"genesis__Funding_in_Tranches__c": false,
"genesis__Financed_Amount__c": 4200,
"genesis__Probability__c": 100,
"genesis__Product_Sub_Type__c": "FINANCE LEASE",
"genesis__Pricing_Method__c": "RATE CARD",
"LastModifiedById": "005F0000002i99wIAA",
"genesis__Sales_Division__c": "DIRECT",
"genesis__Arrears__c": false,
"genesis__Collateral_Value__c": 5678,
"genesis__Documentation_Charges__c": 650,
"genesis__Total_Dealer_Payable__c": 5000,
"genesis__Customer_Cash_Available__c": 0,
"genesis__Contact__c": "003F000001R9znmIAB",
"genesis__Warranty_Amount__c": 0,
"genesis__Landing_Sequence__c": 8,
"genesis__Minimum_Cash_Required__c": 800,
"genesis__Recourse__c": false,
"Name": "APP-0000003955",
"CreatedById": "005F0000002i99wIAA",
"CreatedDate": "2014-05-13T07:08:41.000+0000",
"IsDeleted": false,
"Id": "a39F0000000IVs5IAG",
"genesis__Expected_Close_Date__c": "2014-05-23",
"genesis__Fees_Amount__c": 0,
"genesis__Account__c": "001F0000016OTITIA4"
},
{
"attributes": {
"type": "genesis__Applications__c",
"url": "/services/data/v32.0/sobjects/genesis__Applications__c/a39F0000000IVwvIAG"
},
"genesis__Is_over_21__c": false,
"genesis__Quick_Quote__c": "a02F000000AWbAiIAL",
"RecordTypeId": "012F00000012dIOIAY",
"genesis__Product_Type__c": "LEASE",
"genesis__Estimated_Selling_Price__c": 5000,
"genesis__Payable_To_Dealer__c": 5000,
"genesis__Additional_Cash_Required__c": 4450,
"OwnerId": "005F0000002i99wIAA",
"genesis__Payment_Frequency__c": "MONTHLY",
"genesis__Valid_Pricing_Flag__c": false,
"LastModifiedDate": "2014-05-15T22:31:42.000+0000",
"genesis__Other_Financed_fees__c": 0,
"genesis__Credit_Review__c": false,
"genesis__Company__c": "a1uF00000001YMMIA2",
"genesis__Total_Dealer_Price__c": 5000,
"SystemModstamp": "2015-01-25T16:13:27.000+0000",
"genesis__Tax_Amount__c": 0,
"genesis__Expected_Start_Date__c": "2014-05-14",
"genesis__Status__c": "NEW - ENTERED",
"genesis__Funding_in_Tranches__c": false,
"genesis__Financed_Amount__c": 1200,
"genesis__Probability__c": 100,
"genesis__Product_Sub_Type__c": "FINANCE LEASE",
"genesis__Pricing_Method__c": "RATE CARD",
"LastModifiedById": "005F0000003jZSiIAM",
"genesis__Sales_Division__c": "DIRECT",
"genesis__Arrears__c": false,
"genesis__Collateral_Value__c": 0,
"genesis__Documentation_Charges__c": 650,
"genesis__Total_Dealer_Payable__c": 0,
"genesis__Customer_Cash_Available__c": 0,
"genesis__Contact__c": "003F000001RZqTtIAL",
"genesis__Warranty_Amount__c": 0,
"genesis__Landing_Sequence__c": 4,
"genesis__Minimum_Cash_Required__c": 800,
"genesis__Recourse__c": false,
"Name": "APP-0000004150",
"CreatedById": "005F0000002i99wIAA",
"CreatedDate": "2014-05-14T11:06:17.000+0000",
"IsDeleted": false,
"Id": "a39F0000000IVwvIAG",
"genesis__Expected_Close_Date__c": "2014-05-24",
"genesis__Fees_Amount__c": 0,
"genesis__Account__c": "001F0000016P2iDIAS"
}
]
}