DELETE api/LoanApplication/Cancel

Cancel loan application

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CancellationNotes		string	None.
LoanApplicationId		globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "CancellationNotes": "sample string 1",
  "LoanApplicationId": "4ddf47f8-b9b9-4f1c-8f61-f54121483567"
}

text/html

Sample:

{"CancellationNotes":"sample string 1","LoanApplicationId":"4ddf47f8-b9b9-4f1c-8f61-f54121483567"}

application/xml, text/xml

Sample:

<CancelLoanApplicationRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">
  <LoanApplicationId>4ddf47f8-b9b9-4f1c-8f61-f54121483567</LoanApplicationId>
  <CancellationNotes>sample string 1</CancellationNotes>
</CancelLoanApplicationRequestViewModel>

Response Information

Resource Description

Possible error responses: 1. Invalid loan application id or the user does not have permissions - {"errors": {"invalidFieldName": ["Error message containing more details about the failure."], "invalidFieldName2": ["Error message containing more details about the failure."]}} 2. The loan application is already cancelled - {"LoanApplicationId": "id", "IsSuccessful": "false", "Message": "You can't Cancel this loan application twice."} 3. Invalid loan application status - {"LoanApplicationId": "id", "IsSuccessful": "false", "Message": "This loan application can't be canceled."}

CancelLoanApplicationViewModel

Name	Type	Additional information
IsSuccessful	boolean	None.
Message	string	None.
LoanApplicationId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "Message": "sample string 2",
  "LoanApplicationId": "fb6a3b91-3f0d-4791-8497-5bef5b15904e"
}

text/html

Sample:

{"IsSuccessful":true,"Message":"sample string 2","LoanApplicationId":"fb6a3b91-3f0d-4791-8497-5bef5b15904e"}

application/xml, text/xml

Sample:

<CancelLoanApplicationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">
  <LoanApplicationId>fb6a3b91-3f0d-4791-8497-5bef5b15904e</LoanApplicationId>
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
</CancelLoanApplicationViewModel>