WorkOrders
API endpoints that handle work-order-related requests.
| API | Description |
|---|---|
| GET workorders/{workOrderNumber} |
Retrieves a specific work order and associated items |
| GET workorders/{workOrderNumber}/images | |
| GET workorders |
Retrieves work order summaries |
| POST workorders |
Create work order |
RealPageWidget
API endpoints that handle requests for the RealPage widget URL.
| API | Description |
|---|---|
| POST realpagewidget/{unitid} |
Interacts with RealPage API to build a widget URL. |
Units
API endpoints that handle unit-related requests.
| API | Description |
|---|---|
| GET units/{id}/assets |
Retrieves a unit's assets and assocaited issues |
Suggestions
API endpoints that handle resident's feeback
| API | Description |
|---|---|
| POST suggestions/{username} |
Submit a feedback. |
Utilities
API endpoints that handle app lookups.
| API | Description |
|---|---|
| POST utilities/{admin}/clearcache/{cachename} |
Clear cache |
| GET utilities/apiinfo |
AppLookupLists
API endpoints that handle app lookups.
| API | Description |
|---|---|
| GET applookuplists |
Returns a collection of lookup lists like gender, marital status, etc. |
| GET applookuplists/properties |
Returns a list of properties (and its children properties). |
PPService
API endpoints for Parcel Pending vendor to consume
| API | Description |
|---|---|
| GET ppservice/residents/{uniqueId} |
Allows Parcel Pending vendor to retrieve resident notification preferences |
| POST ppservice/residents/{uniqueId}/preferences |
Allows Parcel Pending vendor to update resident preferences |
| POST ppservice/residents/{uniqueId}/contactinfo |
Allows Parcel Pending vendor to update resident's general contact info like email and/or phone numbers |
| POST ppservice/notifications/{uniqueId} |
Notify |
Parcels
API endpoints that handle Parcel Pending requests.
| API | Description |
|---|---|
| GET parcels/{uniqueId}/{parcelId} | |
| GET parcels/{uniqueId}?pageNumber={pageNumber}&pageSize={pageSize} |
/ |
Residents
API endpoints that handle resident-related requests.
| API | Description |
|---|---|
| GET residents/{userName} |
Retrieves the resident's profile and his/her leased units |
| GET residents/mini/{userName} |
Retrieves a mini/"skinny" version of a resident's profile |
| GET residents/{username}/profilepicture |
Retrieves the profile picture for a user. Streams the picture back to the browser as a BLOB. |
| POST residents/{username}/profilepicture |
Adds or updates a profile picture for a user. Assumes the uploaded picture is a JPEG. Requires a single uploaded file to be POSTed as part of a multipart/form-data upload. |
| POST residents/{username} | |
| POST residents/registration/contactinfo |
Retrieves user's contact info to initiate the registration process |
| POST residents/registration |
Registers users and creates accounts |
PnsRegistration
Register a device to the Authorization Hub.
| API | Description |
|---|---|
| POST pnsregistration/register |
Creates an Azure registration id |
| POST pnsregistration/subscribe |
Subscribe to push notification events |
| DELETE pnsregistration/delete?registrationId={registrationId} |
Delete a registration |
Badges
API endpoints that handle mobile badges.
| API | Description |
|---|---|
| GET badges/{username} |
Retrieves a list of bages by feature |
| POST badges/{username}/unbadge |
Decrements bage |
Pns
| API | Description |
|---|---|
| GET pns/messages/{userName} |
Allows Parcel Pending vendor to retrieve resident notification preferences |