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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AmenityReservationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Request">
  <AmenityId>0</AmenityId>
  <AmenityKey>00000000-0000-0000-0000-000000000000</AmenityKey>
  <Charge>0</Charge>
  <EndTime>0001-01-01T00:00:00</EndTime>
  <EventTitle>String</EventTitle>
  <Notes>String</Notes>
  <OperationalId>String</OperationalId>
  <ReservationDate>0001-01-01T00:00:00</ReservationDate>
  <ReservationId>String</ReservationId>
  <StartTime>0001-01-01T00:00:00</StartTime>
</AmenityReservationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AmenityReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Response">
  <Id>String</Id>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AmenityReservationResponse>