GET breeze/NE/PersonSearch?take={take}&offset={offset}&searchTerms={searchTerms}&personId={personId}&birthDate={birthDate}&genderId={genderId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
take

integer

Required

offset

integer

Required

searchTerms

string

None.

personId

integer

None.

birthDate

date

None.

genderId

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of PersonSearchResult
NameDescriptionTypeAdditional information
PersonId

integer

None.

RecipientNumber

string

None.

FirstName

string

None.

MI

string

None.

LastName

string

None.

BirthDate

date

None.

SSN

string

None.

PIN

string

None.

County

string

None.

Phone

string

None.

MaskedSSN

string

None.

Email

string

None.

LanguageId

integer

None.

Age

integer

None.

AddressLine1

string

None.

AddressLine2

string

None.

City

string

None.

State

string

None.

Zip

string

None.

IsHeadOfHousehold

boolean

None.

HOHFullName

string

None.

MailAddressLine1

string

None.

MailAddressLine2

string

None.

MailCity

string

None.

MailState

string

None.

MailZip

string

None.

CountyId

integer

None.

Score

integer

None.

TotalResults

integer

None.

CityStateZip

string

None.

CaseId

integer

None.

FormattedAddress

string

None.

HOHFormattedAddress

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "$id": "1",
    "$type": "NE.Models.PersonSearchResult, NE.Models",
    "PersonId": 1,
    "RecipientNumber": "sample string 2",
    "FirstName": "sample string 3",
    "MI": "sample string 4",
    "LastName": "sample string 5",
    "BirthDate": "2022-08-18T13:54:40.705+00:00",
    "SSN": "sample string 6",
    "PIN": "sample string 7",
    "County": "sample string 8",
    "Phone": "sample string 9",
    "MaskedSSN": "sample string 10",
    "Email": "sample string 11",
    "LanguageId": 1,
    "Age": 1,
    "AddressLine1": "sample string 12",
    "AddressLine2": "sample string 13",
    "City": "sample string 14",
    "State": "sample string 15",
    "Zip": "sample string 16",
    "IsHeadOfHousehold": true,
    "HOHFullName": "sample string 18",
    "MailAddressLine1": "sample string 19",
    "MailAddressLine2": "sample string 20",
    "MailCity": "sample string 21",
    "MailState": "sample string 22",
    "MailZip": "sample string 23",
    "CountyId": 1,
    "Score": 24,
    "TotalResults": 25,
    "CityStateZip": "sample string 14, sample string 15 sample string 16",
    "CaseId": 1,
    "FormattedAddress": "sample string 12\r\nsample string 13\r\nsample string 14, sample string 15 sample string 16",
    "HOHFormattedAddress": "sample string 19\r\nsample string 20\r\nsample string 21, sample string 22 sample string 23"
  },
  {
    "$ref": "1"
  }
]