GET api/properties/{propertyAddressId}/documents
This method will retrieve all documents generated for a specific property by a particular user
Requires Authorization!
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
propertyAddressId |
Property Address Id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of
Collection of GeneratedDocumentName | Description | Type | Additional information |
---|---|---|---|
OrderId | integer |
None. |
|
OrderNumber | string |
None. |
|
OrderDate | date |
None. |
|
ProductId | integer |
None. |
|
ProductName | string |
None. |
|
ProductDescription | string |
None. |
|
DocumentPath | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "orderId": 1, "orderNumber": "sample string 2", "orderDate": "2025-05-20T15:36:04.5516925-05:00", "productId": 4, "productName": "sample string 5", "productDescription": "sample string 6", "documentPath": "sample string 7" }, { "orderId": 1, "orderNumber": "sample string 2", "orderDate": "2025-05-20T15:36:04.5516925-05:00", "productId": 4, "productName": "sample string 5", "productDescription": "sample string 6", "documentPath": "sample string 7" } ]
text/html
Sample:
[{"orderId":1,"orderNumber":"sample string 2","orderDate":"2025-05-20T15:36:04.5516925-05:00","productId":4,"productName":"sample string 5","productDescription":"sample string 6","documentPath":"sample string 7"},{"orderId":1,"orderNumber":"sample string 2","orderDate":"2025-05-20T15:36:04.5516925-05:00","productId":4,"productName":"sample string 5","productDescription":"sample string 6","documentPath":"sample string 7"}]
application/xml, text/xml
Sample:
<ArrayOfGeneratedDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos"> <GeneratedDocument> <DocumentPath>sample string 7</DocumentPath> <OrderDate>2025-05-20T15:36:04.5516925-05:00</OrderDate> <OrderId>1</OrderId> <OrderNumber>sample string 2</OrderNumber> <ProductDescription>sample string 6</ProductDescription> <ProductId>4</ProductId> <ProductName>sample string 5</ProductName> </GeneratedDocument> <GeneratedDocument> <DocumentPath>sample string 7</DocumentPath> <OrderDate>2025-05-20T15:36:04.5516925-05:00</OrderDate> <OrderId>1</OrderId> <OrderNumber>sample string 2</OrderNumber> <ProductDescription>sample string 6</ProductDescription> <ProductId>4</ProductId> <ProductName>sample string 5</ProductName> </GeneratedDocument> </ArrayOfGeneratedDocument>