GET residentapi/properties/{propertyId}/occupants?sort={sort}&page={page}&pageSize={pageSize}
Get Occupants by property
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| propertyId | integer |
Required |
|
| sort |
(Optional) The order in which to sort the returned occupants. Defaults to occupant last name ascending. The possible values are: lastname, firstname |
string | |
| page |
(Optional)The page number of returned records based on the page size |
integer |
0 |
| pageSize |
(Optional)The number of records to return per page |
integer |
0 |
Body Parameters
None.
Response Information
Resource Description
ListWrapperOfOccupant| Name | Description | Type | Additional information |
|---|---|---|---|
| Total | integer |
None. |
|
| Elements | Collection of Occupant |
None. |
Response Formats
application/json, text/json
Sample:
{
"total": 1,
"elements": [
{
"occupantId": 1,
"propertyId": 2,
"unitId": 3,
"occupantType": "sample string 4",
"firstName": "sample string 5",
"middleInitial": "sample string 6",
"lastName": "sample string 7",
"email": "sample string 8",
"unitPhone": "sample string 9",
"cellphone": "sample string 10",
"workPhone": "sample string 11",
"otherPhone": "sample string 12",
"photos": [
{
"photoId": 1,
"userId": 2,
"fileUrl": "sample string 3",
"isDefault": true
},
{
"photoId": 1,
"userId": 2,
"fileUrl": "sample string 3",
"isDefault": true
}
],
"unitNumber": "sample string 13",
"address1": "sample string 14",
"address2": "sample string 15",
"city": "sample string 16",
"state": "sample string 17",
"zip": "sample string 18",
"isBoardmember": true,
"committeeResidentLinks": [
{
"id": 1,
"committeeId": 2,
"propertyId": 3,
"residentId": 4,
"committees": {
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
"property": {
"propertyId": 1,
"managementOfficeId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"type": "sample string 8",
"phone": "sample string 9",
"faxNumber": "sample string 10",
"startDay": "sample string 11",
"startTime": "sample string 12",
"endDay": "sample string 13",
"endTime": "sample string 14",
"timeZoneDescription": "sample string 15",
"managementOffice": {
"companyId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"phone": "sample string 8",
"fax": "sample string 9",
"country": "sample string 10"
},
"associationManager": {
"id": 1,
"occupantTypeId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"phone": "sample string 6",
"units": [
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
},
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
}
],
"profileImageUrl": "sample string 7",
"isBoardMember": true,
"committees": [
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
}
],
"committeeResidents": [],
"altAddresses": [
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
},
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
}
]
},
"customerCareCenterPhone": "sample string 16",
"socialMedia": {
"twitterUrl": "sample string 1",
"linkedInUrl": "sample string 2",
"googlePlusUrl": "sample string 3",
"pinterestUrl": "sample string 4",
"facebookUrl": "sample string 5"
},
"dfsPath": "sample string 17"
}
},
{
"id": 1,
"committeeId": 2,
"propertyId": 3,
"residentId": 4,
"committees": {
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
"property": {
"propertyId": 1,
"managementOfficeId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"type": "sample string 8",
"phone": "sample string 9",
"faxNumber": "sample string 10",
"startDay": "sample string 11",
"startTime": "sample string 12",
"endDay": "sample string 13",
"endTime": "sample string 14",
"timeZoneDescription": "sample string 15",
"managementOffice": {
"companyId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"phone": "sample string 8",
"fax": "sample string 9",
"country": "sample string 10"
},
"associationManager": {
"id": 1,
"occupantTypeId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"phone": "sample string 6",
"units": [
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
},
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
}
],
"profileImageUrl": "sample string 7",
"isBoardMember": true,
"committees": [
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
}
],
"committeeResidents": [],
"altAddresses": [
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
},
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
}
]
},
"customerCareCenterPhone": "sample string 16",
"socialMedia": {
"twitterUrl": "sample string 1",
"linkedInUrl": "sample string 2",
"googlePlusUrl": "sample string 3",
"pinterestUrl": "sample string 4",
"facebookUrl": "sample string 5"
},
"dfsPath": "sample string 17"
}
}
],
"customerCareNumber": "sample string 20",
"officialOwner": true,
"officialCoOwner": true,
"unOfficialOwner": false
},
{
"occupantId": 1,
"propertyId": 2,
"unitId": 3,
"occupantType": "sample string 4",
"firstName": "sample string 5",
"middleInitial": "sample string 6",
"lastName": "sample string 7",
"email": "sample string 8",
"unitPhone": "sample string 9",
"cellphone": "sample string 10",
"workPhone": "sample string 11",
"otherPhone": "sample string 12",
"photos": [
{
"photoId": 1,
"userId": 2,
"fileUrl": "sample string 3",
"isDefault": true
},
{
"photoId": 1,
"userId": 2,
"fileUrl": "sample string 3",
"isDefault": true
}
],
"unitNumber": "sample string 13",
"address1": "sample string 14",
"address2": "sample string 15",
"city": "sample string 16",
"state": "sample string 17",
"zip": "sample string 18",
"isBoardmember": true,
"committeeResidentLinks": [
{
"id": 1,
"committeeId": 2,
"propertyId": 3,
"residentId": 4,
"committees": {
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
"property": {
"propertyId": 1,
"managementOfficeId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"type": "sample string 8",
"phone": "sample string 9",
"faxNumber": "sample string 10",
"startDay": "sample string 11",
"startTime": "sample string 12",
"endDay": "sample string 13",
"endTime": "sample string 14",
"timeZoneDescription": "sample string 15",
"managementOffice": {
"companyId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"phone": "sample string 8",
"fax": "sample string 9",
"country": "sample string 10"
},
"associationManager": {
"id": 1,
"occupantTypeId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"phone": "sample string 6",
"units": [
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
},
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
}
],
"profileImageUrl": "sample string 7",
"isBoardMember": true,
"committees": [
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
}
],
"committeeResidents": [],
"altAddresses": [
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
},
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
}
]
},
"customerCareCenterPhone": "sample string 16",
"socialMedia": {
"twitterUrl": "sample string 1",
"linkedInUrl": "sample string 2",
"googlePlusUrl": "sample string 3",
"pinterestUrl": "sample string 4",
"facebookUrl": "sample string 5"
},
"dfsPath": "sample string 17"
}
},
{
"id": 1,
"committeeId": 2,
"propertyId": 3,
"residentId": 4,
"committees": {
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
"property": {
"propertyId": 1,
"managementOfficeId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"type": "sample string 8",
"phone": "sample string 9",
"faxNumber": "sample string 10",
"startDay": "sample string 11",
"startTime": "sample string 12",
"endDay": "sample string 13",
"endTime": "sample string 14",
"timeZoneDescription": "sample string 15",
"managementOffice": {
"companyId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"phone": "sample string 8",
"fax": "sample string 9",
"country": "sample string 10"
},
"associationManager": {
"id": 1,
"occupantTypeId": 2,
"firstName": "sample string 3",
"lastName": "sample string 4",
"email": "sample string 5",
"phone": "sample string 6",
"units": [
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
},
{
"unitId": 1,
"unitNumber": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7"
}
],
"profileImageUrl": "sample string 7",
"isBoardMember": true,
"committees": [
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
},
{
"id": 1,
"name": "sample string 2",
"memberCount": 3,
"propertyId": 4
}
],
"committeeResidents": [],
"altAddresses": [
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
},
{
"addressId": 1,
"propertyId": 2,
"unitId": 1,
"address1": "sample string 3",
"address2": "sample string 4",
"city": "sample string 5",
"state": "sample string 6",
"zip": "sample string 7",
"countryCode": "sample string 8",
"isBillingAddress": true,
"isAvsVerified": true,
"isCareOf": true,
"isMilitary": true
}
]
},
"customerCareCenterPhone": "sample string 16",
"socialMedia": {
"twitterUrl": "sample string 1",
"linkedInUrl": "sample string 2",
"googlePlusUrl": "sample string 3",
"pinterestUrl": "sample string 4",
"facebookUrl": "sample string 5"
},
"dfsPath": "sample string 17"
}
}
],
"customerCareNumber": "sample string 20",
"officialOwner": true,
"officialCoOwner": true,
"unOfficialOwner": false
}
]
}