GET documentlist/{apiSiteId}/{loaId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiSiteId

SiteIdentifier

Required

loaId

integer

Required

Body Parameters

None.

Response Information

Resource Description

DocumentListResponse
NameDescriptionTypeAdditional information
listingId

integer

None.

documentList

Collection of DocumentListItem

None.

success

indicates the call was successful or not

boolean

None.

errors

array of error messages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "listingId": 1,
  "documentList": [],
  "success": true,
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<DocumentListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LandAndFarmWebApi.Response">
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <success>true</success>
  <documentList xmlns:d2p1="http://schemas.datacontract.org/2004/07/CoStar.Land.Core" />
  <listingId>1</listingId>
</DocumentListResponse>