| GET | /amenityDetails |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunityCode | query | string | No | |
| AmenityId | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Amenity | form | Amenity | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | form | Guid | No | |
| Id | form | int | No | |
| PropAmenityCategoryKey | form | string | No | |
| Title | form | string | No | |
| Description | form | string | No | |
| Picture | form | string | No | |
| PictureCaption | form | string | No | |
| PictureGivenFileName | form | string | No | |
| Attachment | form | string | No | |
| AttachmentDisplayName | form | string | No | |
| AttachmentGivenFileName | form | string | No | |
| IsActive | form | bool | No | |
| IsReservable | form | bool | No | |
| IsDeleted | form | bool | No | |
| CreatedByName | form | string | No | |
| CreatedDate | form | DateTime | No | |
| LastUpdatedByName | form | string | No | |
| LastUpdatedDate | form | DateTime | No | |
| ReservationSettings | form | AmenityReservationSettings | No | |
| Reservations | form | List<AmenityReservation> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommunityCode | form | string | No | |
| EmailNotification | form | bool | No | |
| TermsandConditions | form | bool | No | |
| IsReservationCharge | form | bool | No | |
| EstimatedCharge | form | decimal? | No | |
| ResourceServiceUrl | form | string | No | |
| LeadTimeStart | form | string | No | |
| LeadTimeEnd | form | string | No | |
| ReservationLimitStart | form | string | No | |
| ReservationLimitEnd | form | string | No | |
| ReservationDurationStart | form | string | No | |
| ReservationDurationEnd | form | string | No | |
| Id | form | string | No | |
| AmenityKey | form | Guid | No | |
| AmenityId | form | int | No | |
| AmenityName | form | string | No | |
| Attachment | form | string | No | |
| AttachmentGivenFileName | form | string | No | |
| CreatedByName | form | string | No | |
| CreatedDate | form | DateTime | No | |
| LastUpdatedByName | form | string | No | |
| LastUpdatedDate | form | DateTime | No | |
| Availability | form | List<Availability> | No | |
| ReservableinRp | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | string | No | |
| title | form | string | No | |
| start | form | string | No | |
| end | form | string | No | |
| day | form | string | No | |
| DOW | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| CommunityCode | form | string | No | |
| AmenityKey | form | Guid | No | |
| AmenityId | form | int | No | |
| LeaseId | form | string | No | |
| PersonId | form | string | No | |
| ReservationType | form | ReservationType | No | |
| EventTitle | form | string | No | |
| AssociateName | form | string | No | |
| Notes | form | string | No | |
| ReservationDate | form | DateTime | No | |
| StartTime | form | DateTime | No | |
| EndTime | form | DateTime | No | |
| Charge | form | decimal | No | |
| CreatedBy | form | string | No | |
| CreatedDate | form | DateTime | No | |
| ModifiedBy | form | string | No | |
| ModifiedDate | form | DateTime | No | |
| IsActive | form | bool | No |
| Community |
| Resident |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /amenityDetails HTTP/1.1 Host: avalonaccessapi.avalonbay.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"amenity":{"key":"00000000-0000-0000-0000-000000000000","id":0,"propAmenityCategoryKey":"String","title":"String","description":"String","picture":"String","pictureCaption":"String","pictureGivenFileName":"String","attachment":"String","attachmentDisplayName":"String","attachmentGivenFileName":"String","isActive":false,"isReservable":false,"isDeleted":false,"createdByName":"String","createdDate":"0001-01-01 00:00:00","lastUpdatedByName":"String","lastUpdatedDate":"0001-01-01 00:00:00","reservationSettings":{"communityCode":"String","emailNotification":false,"termsandConditions":false,"isReservationCharge":false,"estimatedCharge":0,"resourceServiceUrl":"String","leadTimeStart":"String","leadTimeEnd":"String","reservationLimitStart":"String","reservationLimitEnd":"String","reservationDurationStart":"String","reservationDurationEnd":"String","id":"String","amenityKey":"00000000-0000-0000-0000-000000000000","amenityId":0,"amenityName":"String","attachment":"String","attachmentGivenFileName":"String","createdByName":"String","createdDate":"0001-01-01 00:00:00","lastUpdatedByName":"String","lastUpdatedDate":"0001-01-01 00:00:00","availability":[{"id":"String","title":"String","start":"String","end":"String","day":"String","dow":0}],"reservableinRp":false},"reservations":[{"id":"String","communityCode":"String","amenityKey":"00000000-0000-0000-0000-000000000000","amenityId":0,"leaseId":"String","personId":"String","reservationType":"Community","eventTitle":"String","associateName":"String","notes":"String","reservationDate":"0001-01-01 00:00:00","startTime":"0001-01-01 00:00:00","endTime":"0001-01-01 00:00:00","charge":0,"createdBy":"String","createdDate":"0001-01-01 00:00:00","modifiedBy":"String","modifiedDate":"0001-01-01 00:00:00","isActive":false}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}