AvalonAccess API

<back to all web services

ReservedAmenitiesByLeaseRequest

The following routes are available for this service:
GET/reservedAmenitiesByLease
ReservedAmenitiesByLeaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommunityCodequerystringNo
LeaseIdquerystringNo
ReservedAmenitiesByLeaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<Amenity>No
ResponseStatusformResponseStatusNo
Amenity Parameters:
NameParameterData TypeRequiredDescription
KeyformGuidNo
IdformintNo
PropAmenityCategoryKeyformstringNo
TitleformstringNo
DescriptionformstringNo
PictureformstringNo
PictureCaptionformstringNo
PictureGivenFileNameformstringNo
AttachmentformstringNo
AttachmentDisplayNameformstringNo
AttachmentGivenFileNameformstringNo
IsActiveformboolNo
IsReservableformboolNo
IsDeletedformboolNo
CreatedByNameformstringNo
CreatedDateformDateTimeNo
LastUpdatedByNameformstringNo
LastUpdatedDateformDateTimeNo
ReservationSettingsformAmenityReservationSettingsNo
ReservationsformList<AmenityReservation>No
AmenityReservationSettings Parameters:
NameParameterData TypeRequiredDescription
CommunityCodeformstringNo
EmailNotificationformboolNo
TermsandConditionsformboolNo
IsReservationChargeformboolNo
EstimatedChargeformdecimal?No
ResourceServiceUrlformstringNo
LeadTimeStartformstringNo
LeadTimeEndformstringNo
ReservationLimitStartformstringNo
ReservationLimitEndformstringNo
ReservationDurationStartformstringNo
ReservationDurationEndformstringNo
IdformstringNo
AmenityKeyformGuidNo
AmenityIdformintNo
AmenityNameformstringNo
AttachmentformstringNo
AttachmentGivenFileNameformstringNo
CreatedByNameformstringNo
CreatedDateformDateTimeNo
LastUpdatedByNameformstringNo
LastUpdatedDateformDateTimeNo
AvailabilityformList<Availability>No
ReservableinRpformboolNo
Availability Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
titleformstringNo
startformstringNo
endformstringNo
dayformstringNo
DOWformintNo
AmenityReservation Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CommunityCodeformstringNo
AmenityKeyformGuidNo
AmenityIdformintNo
LeaseIdformstringNo
PersonIdformstringNo
ReservationTypeformReservationTypeNo
EventTitleformstringNo
AssociateNameformstringNo
NotesformstringNo
ReservationDateformDateTimeNo
StartTimeformDateTimeNo
EndTimeformDateTimeNo
ChargeformdecimalNo
CreatedByformstringNo
CreatedDateformDateTimeNo
ModifiedByformstringNo
ModifiedDateformDateTimeNo
IsActiveformboolNo
ReservationType Enum:
Community
Resident

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /reservedAmenitiesByLease HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"results":[{"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"}}}