AvalonAccess API

<back to all web services

AmenityReservationRequest

The following routes are available for this service:
POST PUT/amenityReservation
AmenityReservationRequest Parameters:
NameParameterData TypeRequiredDescription
OperationalIdbodystringNo
AmenityKeybodyGuidNo
AmenityIdbodyintNo
ReservationDatebodyDateTimeNo
StartTimebodyDateTimeNo
EndTimebodyDateTimeNo
ChargebodydecimalNo
EventTitlebodystringNo
NotesbodystringNo
ReservationIdbodystringNo
AmenityReservationResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /amenityReservation HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"operationalId":"String","amenityKey":"00000000-0000-0000-0000-000000000000","amenityId":0,"reservationDate":"0001-01-01 00:00:00","startTime":"0001-01-01 00:00:00","endTime":"0001-01-01 00:00:00","charge":0,"eventTitle":"String","notes":"String","reservationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}