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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	operationalId: String,
	amenityId: 0,
	reservationDate: 0001-01-01,
	startTime: 0001-01-01,
	endTime: 0001-01-01,
	charge: 0,
	eventTitle: String,
	notes: String,
	reservationId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}