GET | /onboarding/{NameId} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NameId | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Onboarding | form | OnboardingModel | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Staff | form | List<Staff> | No | |
Onboarding | form | Onboarding | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Firstname | form | string | No | |
Lastname | form | string | No | |
Title | form | string | No | |
Biography | form | string | No | |
PictureUrl | form | string | No | |
IsActive | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .csv suffix or ?format=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"}}}