GET api/people/findbydetails?surname={surname}&postcode={postcode}&email={email}&telephone={telephone}&mobile={mobile}

Searches people based on the fields provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
surname

The surname.

 string

None.
postcode

The postcode.

 string

None.
email

The email address.

 string

None.
telephone

The main telephone.

 string

None.
mobile

The mobile number.

 string

None.

Body Parameters

None.

Response Information

Resource Description

A list of people with the specified fields.

Collection of PersonDataContract
NameDescriptionTypeAdditional information
Gender

EnumDataContract

None.
Title

string

None.
FirstName

string

None.
LastName

string

None.
Note

string

None.
ContactName

string

None.
PrimaryTelephone

ContactItemDataContract

None.
PrimaryEmail

ContactItemDataContract

None.
GroupCount

integer

None.
GroupMemberships

Collection of GroupMembershipDataContract

None.
ContactItems

Collection of ContactItemDataContract

None.
Addresses

Collection of ContactAddressDataContract

None.
ArchivedAddresses

Collection of ContactAddressDataContract

None.
AdditionalInformation

AdditionalInformationDataContract

None.
MarketingPreferences

Collection of MarketingPreferenceDataContract

None.
GroupIds

Collection of integer

None.
HasBankAccounts

boolean

None.
CustomFields

Collection of CustomFieldGroupWithValuesDataContract

None.
CreatedDate

date

None.
CreatedBy

CreatedByDataContract

None.
Id

integer

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path '[0].AdditionalInformation.Documents[0].Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path '[0].AdditionalInformation.Documents[0].Attachments'.