POST api/Entities/FindMatching

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IdNumber	string	None.
Prefix	string	None.
PersonalSuffix	string	None.
ProfessionalSuffix	string	None.
FirstName	string	None.
LastName	string	None.
ReportName	string	None.
FullName	string	None.
DisplayName	string	None.
IsJoint	boolean	None.
SpouseName	string	None.
SpouseIdNumber	string	None.
Email	string	None.
EmailHash	string	None.
Phone	string	None.
Street1	string	None.
Street2	string	None.
Street3	string	None.
City	string	None.
State	string	None.
Zip	string	None.
Country	string	None.
Address	string	None.
Employer	string	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "idNumber": "sample string 1",
  "prefix": "sample string 2",
  "personalSuffix": "sample string 3",
  "professionalSuffix": "sample string 4",
  "firstName": "sample string 5",
  "lastName": "sample string 6",
  "reportName": "sample string 7",
  "fullName": "sample string 5 sample string 6",
  "displayName": "sample string 5 sample string 6 (sample string 1)",
  "isJoint": true,
  "spouseName": "sample string 9",
  "spouseIdNumber": "sample string 10",
  "email": "sample string 11",
  "emailHash": "6fdc314894107950c21e8717c4db3b8e",
  "phone": "sample string 12",
  "street1": "sample string 13",
  "street2": "sample string 14",
  "street3": "sample string 15",
  "city": "sample string 16",
  "state": "sample string 17",
  "zip": "sample string 18",
  "country": "sample string 19",
  "address": "sample string 13 sample string 14, sample string 16, sample string 17 sample string 18 sample string 19",
  "employer": "sample string 20"
}

application/xml, text/xml

Sample:

<DonorDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GiftModels">
  <City>sample string 16</City>
  <Country>sample string 19</Country>
  <Email>sample string 11</Email>
  <Employer>sample string 20</Employer>
  <FirstName>sample string 5</FirstName>
  <IdNumber>sample string 1</IdNumber>
  <IsJoint>true</IsJoint>
  <LastName>sample string 6</LastName>
  <PersonalSuffix>sample string 3</PersonalSuffix>
  <Phone>sample string 12</Phone>
  <Prefix>sample string 2</Prefix>
  <ProfessionalSuffix>sample string 4</ProfessionalSuffix>
  <ReportName>sample string 7</ReportName>
  <SpouseIdNumber>sample string 10</SpouseIdNumber>
  <SpouseName>sample string 9</SpouseName>
  <State>sample string 17</State>
  <Street1>sample string 13</Street1>
  <Street2>sample string 14</Street2>
  <Street3>sample string 15</Street3>
  <Zip>sample string 18</Zip>
</DonorDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of DonorMatchDetail

Name	Type	Additional information
NameDiff	decimal number	None.
Score	decimal number	None.
DonorDetail	DonorDetail	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "nameDiff": 1.1,
    "score": 2.1,
    "donorDetail": {
      "idNumber": "sample string 1",
      "prefix": "sample string 2",
      "personalSuffix": "sample string 3",
      "professionalSuffix": "sample string 4",
      "firstName": "sample string 5",
      "lastName": "sample string 6",
      "reportName": "sample string 7",
      "fullName": "sample string 5 sample string 6",
      "displayName": "sample string 5 sample string 6 (sample string 1)",
      "isJoint": true,
      "spouseName": "sample string 9",
      "spouseIdNumber": "sample string 10",
      "email": "sample string 11",
      "emailHash": "6fdc314894107950c21e8717c4db3b8e",
      "phone": "sample string 12",
      "street1": "sample string 13",
      "street2": "sample string 14",
      "street3": "sample string 15",
      "city": "sample string 16",
      "state": "sample string 17",
      "zip": "sample string 18",
      "country": "sample string 19",
      "address": "sample string 13 sample string 14, sample string 16, sample string 17 sample string 18 sample string 19",
      "employer": "sample string 20"
    }
  },
  {
    "nameDiff": 1.1,
    "score": 2.1,
    "donorDetail": {
      "idNumber": "sample string 1",
      "prefix": "sample string 2",
      "personalSuffix": "sample string 3",
      "professionalSuffix": "sample string 4",
      "firstName": "sample string 5",
      "lastName": "sample string 6",
      "reportName": "sample string 7",
      "fullName": "sample string 5 sample string 6",
      "displayName": "sample string 5 sample string 6 (sample string 1)",
      "isJoint": true,
      "spouseName": "sample string 9",
      "spouseIdNumber": "sample string 10",
      "email": "sample string 11",
      "emailHash": "6fdc314894107950c21e8717c4db3b8e",
      "phone": "sample string 12",
      "street1": "sample string 13",
      "street2": "sample string 14",
      "street3": "sample string 15",
      "city": "sample string 16",
      "state": "sample string 17",
      "zip": "sample string 18",
      "country": "sample string 19",
      "address": "sample string 13 sample string 14, sample string 16, sample string 17 sample string 18 sample string 19",
      "employer": "sample string 20"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfDonorMatchDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GivingService.Models">
  <DonorMatchDetail>
    <DonorDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GiftModels">
      <d3p1:City>sample string 16</d3p1:City>
      <d3p1:Country>sample string 19</d3p1:Country>
      <d3p1:Email>sample string 11</d3p1:Email>
      <d3p1:Employer>sample string 20</d3p1:Employer>
      <d3p1:FirstName>sample string 5</d3p1:FirstName>
      <d3p1:IdNumber>sample string 1</d3p1:IdNumber>
      <d3p1:IsJoint>true</d3p1:IsJoint>
      <d3p1:LastName>sample string 6</d3p1:LastName>
      <d3p1:PersonalSuffix>sample string 3</d3p1:PersonalSuffix>
      <d3p1:Phone>sample string 12</d3p1:Phone>
      <d3p1:Prefix>sample string 2</d3p1:Prefix>
      <d3p1:ProfessionalSuffix>sample string 4</d3p1:ProfessionalSuffix>
      <d3p1:ReportName>sample string 7</d3p1:ReportName>
      <d3p1:SpouseIdNumber>sample string 10</d3p1:SpouseIdNumber>
      <d3p1:SpouseName>sample string 9</d3p1:SpouseName>
      <d3p1:State>sample string 17</d3p1:State>
      <d3p1:Street1>sample string 13</d3p1:Street1>
      <d3p1:Street2>sample string 14</d3p1:Street2>
      <d3p1:Street3>sample string 15</d3p1:Street3>
      <d3p1:Zip>sample string 18</d3p1:Zip>
    </DonorDetail>
    <NameDiff>1.1</NameDiff>
    <Score>2.1</Score>
  </DonorMatchDetail>
  <DonorMatchDetail>
    <DonorDetail xmlns:d3p1="http://schemas.datacontract.org/2004/07/GiftModels">
      <d3p1:City>sample string 16</d3p1:City>
      <d3p1:Country>sample string 19</d3p1:Country>
      <d3p1:Email>sample string 11</d3p1:Email>
      <d3p1:Employer>sample string 20</d3p1:Employer>
      <d3p1:FirstName>sample string 5</d3p1:FirstName>
      <d3p1:IdNumber>sample string 1</d3p1:IdNumber>
      <d3p1:IsJoint>true</d3p1:IsJoint>
      <d3p1:LastName>sample string 6</d3p1:LastName>
      <d3p1:PersonalSuffix>sample string 3</d3p1:PersonalSuffix>
      <d3p1:Phone>sample string 12</d3p1:Phone>
      <d3p1:Prefix>sample string 2</d3p1:Prefix>
      <d3p1:ProfessionalSuffix>sample string 4</d3p1:ProfessionalSuffix>
      <d3p1:ReportName>sample string 7</d3p1:ReportName>
      <d3p1:SpouseIdNumber>sample string 10</d3p1:SpouseIdNumber>
      <d3p1:SpouseName>sample string 9</d3p1:SpouseName>
      <d3p1:State>sample string 17</d3p1:State>
      <d3p1:Street1>sample string 13</d3p1:Street1>
      <d3p1:Street2>sample string 14</d3p1:Street2>
      <d3p1:Street3>sample string 15</d3p1:Street3>
      <d3p1:Zip>sample string 18</d3p1:Zip>
    </DonorDetail>
    <NameDiff>1.1</NameDiff>
    <Score>2.1</Score>
  </DonorMatchDetail>
</ArrayOfDonorMatchDetail>