DELETE api/LoanApplication/Cancel

Cancel loan application

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

{
  "CancellationNotes": "sample string 1",
  "LoanApplicationId": "fd5a639f-4206-4781-9d47-28ecda77e0a2",
  "ShouldSkipEmailSending": true
}

text/html

Sample:

{"CancellationNotes":"sample string 1","LoanApplicationId":"fd5a639f-4206-4781-9d47-28ecda77e0a2","ShouldSkipEmailSending":true}

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>fd5a639f-4206-4781-9d47-28ecda77e0a2</LoanApplicationId>
  <ShouldSkipEmailSending>true</ShouldSkipEmailSending>
  <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.
ShouldSkipEmailSending	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "Message": "sample string 2",
  "LoanApplicationId": "51dd4bce-7701-4225-9713-d34bd7583a29",
  "ShouldSkipEmailSending": true
}

text/html

Sample:

{"IsSuccessful":true,"Message":"sample string 2","LoanApplicationId":"51dd4bce-7701-4225-9713-d34bd7583a29","ShouldSkipEmailSending":true}

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>51dd4bce-7701-4225-9713-d34bd7583a29</LoanApplicationId>
  <ShouldSkipEmailSending>true</ShouldSkipEmailSending>
  <IsSuccessful>true</IsSuccessful>
  <Message>sample string 2</Message>
</CancelLoanApplicationViewModel>