GET api/LoanApplication/Documents/{loanApplicationId}/{documentsFormat}

Get all documents for a loan application

Request Information

URI Parameters

Name	Description	Type	Additional information
loanApplicationId		globally unique identifier	Required
documentsFormat		DocumentFormatEnum	Default value is PDF

Body Parameters

None.

Response Information

Resource Description

Possible error responses: 1. Already signed loan application - {"errors": {"invalidFieldName": ["Error message containing more details about the failure."], "invalidFieldName2": ["Error message containing more details about the failure."]}}

APIDocumentsViewModel

Name	Type	Additional information
Documents	Dictionary of string [key] and string [value]	None.
ReturnedDocumentsFormat	DocumentFormatEnum	None.
LoanApplicationId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "Documents": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ReturnedDocumentsFormat": 1,
  "LoanApplicationId": "566a6a89-4532-47cd-86a1-1b6d63da0191"
}

text/html

Sample:

{"Documents":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"ReturnedDocumentsFormat":1,"LoanApplicationId":"566a6a89-4532-47cd-86a1-1b6d63da0191"}

application/xml, text/xml

Sample:

<APIDocumentsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
  <LoanApplicationId xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">566a6a89-4532-47cd-86a1-1b6d63da0191</LoanApplicationId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Documents>
  <ReturnedDocumentsFormat>PDF</ReturnedDocumentsFormat>
</APIDocumentsViewModel>