GET residentapi/properties/{propertyId}/documentsubtypes?documentTypeId={documentTypeId}&includePrivateDocuments={includePrivateDocuments}

Get document subtypes by documentTypeId that have at least one document associated with it in alphabetical order

Request Information

URI Parameters

NameDescriptionTypeAdditional information
propertyId

(Required)

integer

Required

documentTypeId

(optional) The documentTypeId associated to the subtypes

integer

0

includePrivateDocuments

boolean

False

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfDocumentSubtype
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of DocumentSubtype

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "elements": [
    {
      "documentSubtypeId": 1,
      "documentTypeId": 1,
      "name": "sample string 2",
      "displayOrder": 1
    },
    {
      "documentSubtypeId": 1,
      "documentTypeId": 1,
      "name": "sample string 2",
      "displayOrder": 1
    }
  ]
}