Update Spreading Status API
Description
This web service is to update the spreading status back to Cloud Lending.
Definition
Post https://<domain>/services/apexrest/CLS/PostSpreadingStatus/
Authentication Type
Basic Salesforce Auth 2.0See 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 | Type |
|---|---|
| system_name | string |
| correlation_id | string |
| date_timestamp | string |
| process_control_number | string |
| company_name | string |
| obligor_id | string |
| spread_type | string |
| spread_status | string |
| spread_error_code | string |
| spread_case_id | string |
| overall_spread_notes | string |
| spread_start | string |
| spread_end | string |
| spreader_name | string |
| id_value | string |
| id_type | string |
| account_number | integer |
| routing_number | integer |
| bank_name | string |
| full_account_and_routing_number_extracted | boolean |
| document_id | string |
| file_id | string |
| document_status | string |
| document_rejection_reason | string |
| document_notes | 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 Code | Error Message | System.Label | |
|---|---|---|---|---|
| 500 | HTTP_INTERNAL_ERROR | Unable to parse the request parameters. | genesis.Constants.HTTP_INTERNAL_ERROR | Error getting the request parameters from the request body. |
400 | INVALID_INPUT | One or more required params are missing or invalid. | Label.CLS_WS_error_message |
Sample Request
The sample request to be sent is as shown in the following block.
{
"spreading_status_information": {
"spreader_information": {
"spreader_name": "123456789",
"spreader_id": [
{
"id_value": "123456789",
"id_type": "DL"
},
{
"id_value": "123456789",
"id_type": "DL"
}
]
},
"spread_type": "Financial_Statements",
"spread_status": "Pass",
"spread_start": "123456789",
"spread_error_code": "123456789",
"spread_end": "123456789",
"spread_case_id": "123456789",
"overall_spread_notes": "123456789",
"document_information": [
{
"file_id": "324222",
"document_status": "Submitted",
"document_rejection_reason": "",
"document_notes": "",
"document_id": "4322323"
},
{
"file_id": "342323",
"document_status": "Submitted",
"document_rejection_reason": "",
"document_notes": "",
"document_id": "333232"
}
],
"bank_information": [
{
"routing_number": 123456,
"full_account_and_routing_number_extracted": true,
"bank_name": "asjdc",
"account_number": 123456789
},
{
"routing_number": 123456,
"full_account_and_routing_number_extracted": true,
"bank_name": "asjdc",
"account_number": 123456789
}
]
},
"requestor_information": {
"system_name": "CP",
"date_timestamp": "3/11/2020 5:24",
"correlation_id": "123123"
},
"application_information": {
"process_control_number": "123456789",
"business_information": {
"obligor_id": "12345678990",
"company_name": "Abc Company"
}
}
}Sample Response
The sample response that you receive is as shown in the following block.
{
"status_code": 200,
"status": "SUCCESS",
"row_number": null,
"error_message": null,
"error_code": "NO_ERROR",
"content": []
}