AvalonAccess API

AmenityDetailsRequest

The following routes are available for this service:
GET	/amenityDetails

**AmenityDetailsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CommunityCode	query	string	No
AmenityId	query	int	No

**AmenityDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Amenity	form	Amenity	No
ResponseStatus	form	ResponseStatus	No

**Amenity** Parameters:
Name	Parameter	Data Type	Required
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

**AmenityReservationSettings** Parameters:
Name	Parameter	Data Type	Required
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

**Availability** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
title	form	string	No
start	form	string	No
end	form	string	No
day	form	string	No
DOW	form	int	No

**AmenityReservation** Parameters:
Name	Parameter	Data Type	Required
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

**ReservationType** Enum:
Community
Resident

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.

GET /amenityDetails HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AmenityDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Response">
  <Amenity xmlns:d2p1="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Models">
    <d2p1:Attachment>String</d2p1:Attachment>
    <d2p1:AttachmentDisplayName>String</d2p1:AttachmentDisplayName>
    <d2p1:AttachmentGivenFileName>String</d2p1:AttachmentGivenFileName>
    <d2p1:CreatedByName>String</d2p1:CreatedByName>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsReservable>false</d2p1:IsReservable>
    <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
    <d2p1:LastUpdatedByName>String</d2p1:LastUpdatedByName>
    <d2p1:LastUpdatedDate>0001-01-01T00:00:00</d2p1:LastUpdatedDate>
    <d2p1:Picture>String</d2p1:Picture>
    <d2p1:PictureCaption>String</d2p1:PictureCaption>
    <d2p1:PictureGivenFileName>String</d2p1:PictureGivenFileName>
    <d2p1:PropAmenityCategoryKey>String</d2p1:PropAmenityCategoryKey>
    <d2p1:ReservationSettings>
      <d2p1:AmenityId>0</d2p1:AmenityId>
      <d2p1:AmenityKey>00000000-0000-0000-0000-000000000000</d2p1:AmenityKey>
      <d2p1:AmenityName>String</d2p1:AmenityName>
      <d2p1:Attachment>String</d2p1:Attachment>
      <d2p1:AttachmentGivenFileName>String</d2p1:AttachmentGivenFileName>
      <d2p1:Availability>
        <d2p1:Availability>
          <d2p1:DOW>0</d2p1:DOW>
          <d2p1:day>String</d2p1:day>
          <d2p1:end>String</d2p1:end>
          <d2p1:id>String</d2p1:id>
          <d2p1:start>String</d2p1:start>
          <d2p1:title>String</d2p1:title>
        </d2p1:Availability>
      </d2p1:Availability>
      <d2p1:CommunityCode>String</d2p1:CommunityCode>
      <d2p1:CreatedByName>String</d2p1:CreatedByName>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:EmailNotification>false</d2p1:EmailNotification>
      <d2p1:EstimatedCharge>0</d2p1:EstimatedCharge>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:IsReservationCharge>false</d2p1:IsReservationCharge>
      <d2p1:LastUpdatedByName>String</d2p1:LastUpdatedByName>
      <d2p1:LastUpdatedDate>0001-01-01T00:00:00</d2p1:LastUpdatedDate>
      <d2p1:LeadTimeEnd>String</d2p1:LeadTimeEnd>
      <d2p1:LeadTimeStart>String</d2p1:LeadTimeStart>
      <d2p1:ReservableinRp>false</d2p1:ReservableinRp>
      <d2p1:ReservationDurationEnd>String</d2p1:ReservationDurationEnd>
      <d2p1:ReservationDurationStart>String</d2p1:ReservationDurationStart>
      <d2p1:ReservationLimitEnd>String</d2p1:ReservationLimitEnd>
      <d2p1:ReservationLimitStart>String</d2p1:ReservationLimitStart>
      <d2p1:ResourceServiceUrl>String</d2p1:ResourceServiceUrl>
      <d2p1:TermsandConditions>false</d2p1:TermsandConditions>
    </d2p1:ReservationSettings>
    <d2p1:Reservations>
      <d2p1:AmenityReservation>
        <d2p1:AmenityId>0</d2p1:AmenityId>
        <d2p1:AmenityKey>00000000-0000-0000-0000-000000000000</d2p1:AmenityKey>
        <d2p1:AssociateName>String</d2p1:AssociateName>
        <d2p1:Charge>0</d2p1:Charge>
        <d2p1:CommunityCode>String</d2p1:CommunityCode>
        <d2p1:CreatedBy>String</d2p1:CreatedBy>
        <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
        <d2p1:EndTime>0001-01-01T00:00:00</d2p1:EndTime>
        <d2p1:EventTitle>String</d2p1:EventTitle>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:IsActive>false</d2p1:IsActive>
        <d2p1:LeaseId>String</d2p1:LeaseId>
        <d2p1:ModifiedBy>String</d2p1:ModifiedBy>
        <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:Notes>String</d2p1:Notes>
        <d2p1:PersonId>String</d2p1:PersonId>
        <d2p1:ReservationDate>0001-01-01T00:00:00</d2p1:ReservationDate>
        <d2p1:ReservationType>Community</d2p1:ReservationType>
        <d2p1:StartTime>0001-01-01T00:00:00</d2p1:StartTime>
      </d2p1:AmenityReservation>
    </d2p1:Reservations>
    <d2p1:Title>String</d2p1:Title>
  </Amenity>
  <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>
</AmenityDetailsResponse>