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 .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.

GET /onboarding/{NameId} HTTP/1.1 
Host: avalonaccessapi.avalonbay.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	onboarding: 
	{
		staff: 
		[
			{
				firstname: String,
				lastname: String,
				title: String,
				biography: String,
				pictureUrl: String,
				isActive: False
			}
		],
		onboarding: 
		{
			pdf: String,
			pdfDescription: String,
			vehicleRegistrationRequired: False,
			petRegistrationRequired: False,
			welcomeMessage: String
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}