GET api/private/Contacts/SearchByEmail?email={email}&firstName={firstName}&lastName={lastName}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
Default value is |
||
| firstName | string |
Default value is |
|
| lastName | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Domain.Contact.ContactListItemSearchDto| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRecords | integer |
None. |
|
| CurrentPage | integer |
None. |
|
| PageSize | integer |
None. |
|
| List | Collection of Domain.Contact.ContactListItemDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalRecords": 1,
"CurrentPage": 2,
"PageSize": 3,
"List": [
{
"ContactId": "sample string 1",
"ContactDto": {
"ContactId": "sample string 1",
"ContactTypeId": 1,
"ContactTypeName": "sample string 2",
"Comment": "sample string 3",
"Title": "sample string 4",
"Email": "sample string 5",
"StartDate": "sample string 6",
"EndDate": "sample string 7",
"ApplicationToken": "sample string 8",
"ProgramName": "sample string 9",
"Addresses": [
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
},
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
}
],
"Phones": [
{
"PhoneId": 1,
"PhoneType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"PhoneTypeId": 1,
"PhoneTypeName": "sample string 2",
"PhoneNumber": "sample string 3",
"Comment": "sample string 4",
"CountryCode": "sample string 5"
},
{
"PhoneId": 1,
"PhoneType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"PhoneTypeId": 1,
"PhoneTypeName": "sample string 2",
"PhoneNumber": "sample string 3",
"Comment": "sample string 4",
"CountryCode": "sample string 5"
}
],
"personPartyId": "sample string 10",
"Person": {
"PartyId": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"FullName": "sample string 5",
"Dob": "sample string 6",
"ApplicationToken": "sample string 7",
"PartyAliases": [
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
},
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
}
],
"Contacts": [],
"LastModifiedBy": "sample string 8"
},
"ContactType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"organizationPartyId": "sample string 11",
"Organization": {
"PartyId": "sample string 1",
"OrganizationName": "sample string 2",
"DoBusinessAs": "sample string 3",
"OrganizationCode": "sample string 4",
"OrganizationDetails": "sample string 5",
"OrganizationSize": 1,
"StartDate": "sample string 6",
"EndDate": "sample string 7",
"OrganizationTypeId": 1,
"OrganizationTypeName": "sample string 8",
"OrganizationTypeCode": "sample string 9",
"ContactNameDepartment": "sample string 10",
"Url": "sample string 11",
"ApplicationToken": "sample string 12",
"Addresses": [
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
},
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
}
],
"PartyAliases": [
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
},
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
}
],
"OrganizationType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"OrganizationTypeCode": "sample string 4"
},
"LastModifiedBy": "sample string 13"
},
"Roles": [
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
}
],
"ContactRoleId": 1,
"ContactRoleName": "sample string 12",
"LastModifiedBy": "sample string 13"
},
"PersonPartyId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"OrganizationName": "sample string 5",
"OrganizationPartyId": "sample string 6",
"Person": {
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Middlename": "sample string 3",
"partyId": "sample string 4",
"taxId": "sample string 5",
"vcc": "sample string 6",
"externalPartyId": "sample string 7"
},
"Organization": {
"organizationName": "sample string 1",
"partyId": "sample string 2",
"taxId": "sample string 3",
"vcc": "sample string 4",
"externalPartyId": "sample string 5"
}
},
{
"ContactId": "sample string 1",
"ContactDto": {
"ContactId": "sample string 1",
"ContactTypeId": 1,
"ContactTypeName": "sample string 2",
"Comment": "sample string 3",
"Title": "sample string 4",
"Email": "sample string 5",
"StartDate": "sample string 6",
"EndDate": "sample string 7",
"ApplicationToken": "sample string 8",
"ProgramName": "sample string 9",
"Addresses": [
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
},
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
}
],
"Phones": [
{
"PhoneId": 1,
"PhoneType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"PhoneTypeId": 1,
"PhoneTypeName": "sample string 2",
"PhoneNumber": "sample string 3",
"Comment": "sample string 4",
"CountryCode": "sample string 5"
},
{
"PhoneId": 1,
"PhoneType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"PhoneTypeId": 1,
"PhoneTypeName": "sample string 2",
"PhoneNumber": "sample string 3",
"Comment": "sample string 4",
"CountryCode": "sample string 5"
}
],
"personPartyId": "sample string 10",
"Person": {
"PartyId": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"MiddleName": "sample string 4",
"FullName": "sample string 5",
"Dob": "sample string 6",
"ApplicationToken": "sample string 7",
"PartyAliases": [
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
},
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
}
],
"Contacts": [],
"LastModifiedBy": "sample string 8"
},
"ContactType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
"organizationPartyId": "sample string 11",
"Organization": {
"PartyId": "sample string 1",
"OrganizationName": "sample string 2",
"DoBusinessAs": "sample string 3",
"OrganizationCode": "sample string 4",
"OrganizationDetails": "sample string 5",
"OrganizationSize": 1,
"StartDate": "sample string 6",
"EndDate": "sample string 7",
"OrganizationTypeId": 1,
"OrganizationTypeName": "sample string 8",
"OrganizationTypeCode": "sample string 9",
"ContactNameDepartment": "sample string 10",
"Url": "sample string 11",
"ApplicationToken": "sample string 12",
"Addresses": [
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
},
{
"AddressId": "sample string 1",
"StreetAddress1": "sample string 2",
"StreetAddress2": "sample string 3",
"PostalTown": {
"TownId": 1,
"TownName": "sample string 2",
"IsOfficial": true,
"CountyId": 1,
"CountyName": "sample string 4"
},
"TownId": 1,
"TownName": "sample string 4",
"MunicipalId": 1,
"MunicipalName": "sample string 5",
"PostalCounty": {
"CountyId": 1,
"CountyName": "sample string 2"
},
"CountyId": 1,
"County": "sample string 6",
"CountyName": "sample string 7",
"PostalState": {
"StateId": 1,
"StateCode": "sample string 2",
"StateDescription": "sample string 3"
},
"StateId": 1,
"StateName": "sample string 8",
"StateCode": "sample string 9",
"PostalZip": {
"ZipId": 1,
"ZipCode": "sample string 2"
},
"ZipId": 1,
"ZipCode": "sample string 10",
"PostalCountry": {
"CountryId": 1,
"CountryCode": "sample string 2",
"CountryName": "sample string 3"
},
"CountryId": 1,
"Country": "sample string 11",
"CountryCode": "sample string 12",
"IsForeign": true,
"ForeignTown": "sample string 14",
"ForeignPostalCode": "sample string 15",
"ForeignState": "sample string 16",
"ExternalLocationId": "sample string 17",
"DivisionDepartment": "sample string 18",
"AdditionalAddressInformation": "sample string 19",
"CityRegionCode": "sample string 20",
"Latitude": 21.1,
"Longitude": 22.1,
"PostalAddressFull": "sample string 23"
}
],
"PartyAliases": [
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
},
{
"PartyAliasId": 1,
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"LastName": "sample string 4",
"CompanyName": "sample string 5",
"Comment": "sample string 6"
}
],
"OrganizationType": {
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3",
"OrganizationTypeCode": "sample string 4"
},
"LastModifiedBy": "sample string 13"
},
"Roles": [
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"Description": "sample string 3"
}
],
"ContactRoleId": 1,
"ContactRoleName": "sample string 12",
"LastModifiedBy": "sample string 13"
},
"PersonPartyId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"OrganizationName": "sample string 5",
"OrganizationPartyId": "sample string 6",
"Person": {
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Middlename": "sample string 3",
"partyId": "sample string 4",
"taxId": "sample string 5",
"vcc": "sample string 6",
"externalPartyId": "sample string 7"
},
"Organization": {
"organizationName": "sample string 1",
"partyId": "sample string 2",
"taxId": "sample string 3",
"vcc": "sample string 4",
"externalPartyId": "sample string 5"
}
}
]
}
text/xml
Sample:
Sample not available.