AvalonAccess API

OnboardingRequest

The following routes are available for this service:
GET	/onboarding/{NameId}

**OnboardingRequest** Parameters:
Name	Parameter	Data Type	Required	Description
NameId	path	string	No

**OnboardingResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Onboarding	form	OnboardingModel	No
ResponseStatus	form	ResponseStatus	No

**OnboardingModel** Parameters:
Name	Parameter	Data Type	Required	Description
Staff	form	List<Staff>	No
Onboarding	form	Onboarding	No

**Staff** Parameters:
Name	Parameter	Data Type	Required
Firstname	form	string	No
Lastname	form	string	No
Title	form	string	No
Biography	form	string	No
PictureUrl	form	string	No
IsActive	form	bool	No

**Onboarding** Parameters:
Name	Parameter	Data Type	Required
Pdf	form	string	No
PdfDescription	form	string	No
VehicleRegistrationRequired	form	bool	No
PetRegistrationRequired	form	bool	No
WelcomeMessage	form	string	No

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 /onboarding/{NameId} HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: application/xml

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

<OnboardingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Response">
  <Onboarding xmlns:d2p1="http://schemas.datacontract.org/2004/07/AvalonAccessAPI.ServiceModel.Models">
    <d2p1:Onboarding>
      <d2p1:Pdf>String</d2p1:Pdf>
      <d2p1:PdfDescription>String</d2p1:PdfDescription>
      <d2p1:PetRegistrationRequired>false</d2p1:PetRegistrationRequired>
      <d2p1:VehicleRegistrationRequired>false</d2p1:VehicleRegistrationRequired>
      <d2p1:WelcomeMessage>String</d2p1:WelcomeMessage>
    </d2p1:Onboarding>
    <d2p1:Staff>
      <d2p1:Staff>
        <d2p1:Biography>String</d2p1:Biography>
        <d2p1:Firstname>String</d2p1:Firstname>
        <d2p1:IsActive>false</d2p1:IsActive>
        <d2p1:Lastname>String</d2p1:Lastname>
        <d2p1:PictureUrl>String</d2p1:PictureUrl>
        <d2p1:Title>String</d2p1:Title>
      </d2p1:Staff>
    </d2p1:Staff>
  </Onboarding>
  <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>
</OnboardingResponse>