Gets the documents linked to the provided report.
This method will only return documents when the status of the report is 'Completed'. Otherwhise a 404 (Not found) will be returned, including a message with the current flowstatus.
| Name | Description | Type | Additional information |
|---|---|---|---|
reportId |
The identifier of the report. |
integer |
Required |
None.
A list of documents.
Collection of ChappReport.Site.Areas.Api.Models.V1.ReportDocumentV1ModelResponse| Name | Description | Type | Additional information |
|---|---|---|---|
Id |
The id of the document. |
integer |
None. |
Url |
The uri where the document data can be retrieved. |
string |
None. |
Type |
The type of the document. Possible values: Report, LongList, ShortList, JobList, Addendum, Settlement |
string |
None. |
Created |
The date the document was created. |
date |
None. |
FileName |
the localized document filename |
string |
None. |
[
{
"Id": 1,
"Url": "http://rental.chapps.com/Reports/1/Documents/1",
"Type": "Report",
"Created": "0001-01-01T00:00:00"
},
{
"Id": 2,
"Url": "http://rental.chapps.com/Reports/1/Documents/2",
"Type": "ShortList",
"Created": "0001-01-01T00:00:00"
}
]
<ArrayOfReportDocumentV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
<ReportDocumentV1ModelResponse>
<Created>0001-01-01T00:00:00</Created>
<FileName i:nil="true" />
<Id>1</Id>
<Type>Report</Type>
<Url>http://rental.chapps.com/Reports/1/Documents/1</Url>
</ReportDocumentV1ModelResponse>
<ReportDocumentV1ModelResponse>
<Created>0001-01-01T00:00:00</Created>
<FileName i:nil="true" />
<Id>2</Id>
<Type>ShortList</Type>
<Url>http://rental.chapps.com/Reports/1/Documents/2</Url>
</ReportDocumentV1ModelResponse>
</ArrayOfReportDocumentV1ModelResponse>