AvalonAccess API

<back to all web services

OnboardingRequest

The following routes are available for this service:
GET/onboarding/{NameId}
OnboardingRequest Parameters:
NameParameterData TypeRequiredDescription
NameIdpathstringNo
OnboardingResponse Parameters:
NameParameterData TypeRequiredDescription
OnboardingformOnboardingModelNo
ResponseStatusformResponseStatusNo
OnboardingModel Parameters:
NameParameterData TypeRequiredDescription
StaffformList<Staff>No
OnboardingformOnboardingNo
Staff Parameters:
NameParameterData TypeRequiredDescription
FirstnameformstringNo
LastnameformstringNo
TitleformstringNo
BiographyformstringNo
PictureUrlformstringNo
IsActiveformboolNo
Onboarding Parameters:
NameParameterData TypeRequiredDescription
PdfformstringNo
PdfDescriptionformstringNo
VehicleRegistrationRequiredformboolNo
PetRegistrationRequiredformboolNo
WelcomeMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}