GET ppservice/residents/{uniqueId}

Allows Parcel Pending vendor to retrieve resident notification preferences

Request Information

URI Parameters

NameDescriptionTypeAdditional information
uniqueId

A unique email Id

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns a NotificationPreferences object

PPResidentProfileView
NameDescriptionTypeAdditional information
FirstName

Resident's first name

string

Required

Max length: 30

LastName

Resident's last name

string

Required

Max length: 30

Email

Resident's email

string

Max length: 250

HomePhone

Resident's home phone

string

Max length: 25

CellPhone

Resident's cell phone

string

Max length: 25

WorkPhone

Resident's work phone

string

Max length: 25

Preferences

Encapsulates user's communication preferences including as well as ADA option.

ResidentPreferences

None.

Response Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "HomePhone": "sample string 4",
  "CellPhone": "sample string 5",
  "WorkPhone": "sample string 6",
  "Preferences": {
    "NotifyByEmail": true,
    "NotifyByPNS": true,
    "NotifyByText": true,
    "ADAEnabled": true
  }
}