POST api/contacts/BasicMatchByContactBasicSearchParamsForPrincipalWizard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ContactTypeID	integer	None.
ContactCategoryID	integer	None.
ParentEntityIDs	string	None.
UserGroupTypeIDs	string	None.
UserGroupIDs	string	None.
RoleIDs	string	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
UserName	string	None.
IsUser	boolean	None.
IsCompany	boolean	None.
EntityID	integer	None.
DOB	date	None.
Postcode	string	None.
DriversLicenceNumber	string	None.
DriversLicenseStateID	integer	None.
ShowInactive	boolean	None.
IssueDate	date	None.
Address	string	None.
Suburb	string	None.
Address2	string	None.
Address3	string	None.
StateID	integer	None.
ExpiationNoticeNumber	string	None.
OutsourceEntityID	integer	None.
EntityName	string	None.
BusinessNumber	string	None.
CorporationNumber	string	None.
CountryID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ContactTypeID": 1,
  "ContactCategoryID": 1,
  "ParentEntityIDs": "sample string 1",
  "UserGroupTypeIDs": "sample string 2",
  "UserGroupIDs": "sample string 3",
  "RoleIDs": "sample string 4",
  "FirstName": "sample string 5",
  "MiddleName": "sample string 6",
  "LastName": "sample string 7",
  "UserName": "sample string 8",
  "IsUser": true,
  "IsCompany": true,
  "EntityID": 1,
  "DOB": "2025-09-02T23:04:24.1336925+00:00",
  "Postcode": "sample string 10",
  "DriversLicenceNumber": "sample string 11",
  "DriversLicenseStateID": 1,
  "ShowInactive": true,
  "IssueDate": "2025-09-02T23:04:24.1336925+00:00",
  "Address": "sample string 13",
  "Suburb": "sample string 14",
  "Address2": "sample string 15",
  "Address3": "sample string 16",
  "StateID": 1,
  "ExpiationNoticeNumber": "sample string 17",
  "OutsourceEntityID": 1,
  "EntityName": "sample string 18",
  "BusinessNumber": "sample string 19",
  "CorporationNumber": "sample string 20",
  "CountryID": 1
}

application/xml, text/xml

Sample:

<ContactBasicSearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact">
  <Address>sample string 13</Address>
  <Address2>sample string 15</Address2>
  <Address3>sample string 16</Address3>
  <BusinessNumber>sample string 19</BusinessNumber>
  <ContactCategoryID>1</ContactCategoryID>
  <ContactTypeID>1</ContactTypeID>
  <CorporationNumber>sample string 20</CorporationNumber>
  <CountryID>1</CountryID>
  <DOB>2025-09-02T23:04:24.1336925+00:00</DOB>
  <DriversLicenceNumber>sample string 11</DriversLicenceNumber>
  <DriversLicenseStateID>1</DriversLicenseStateID>
  <EntityID>1</EntityID>
  <EntityName>sample string 18</EntityName>
  <ExpiationNoticeNumber>sample string 17</ExpiationNoticeNumber>
  <FirstName>sample string 5</FirstName>
  <IsCompany>true</IsCompany>
  <IsUser>true</IsUser>
  <IssueDate>2025-09-02T23:04:24.1336925+00:00</IssueDate>
  <LastName>sample string 7</LastName>
  <MiddleName>sample string 6</MiddleName>
  <OutsourceEntityID>1</OutsourceEntityID>
  <ParentEntityIDs>sample string 1</ParentEntityIDs>
  <Postcode>sample string 10</Postcode>
  <RoleIDs>sample string 4</RoleIDs>
  <ShowInactive>true</ShowInactive>
  <StateID>1</StateID>
  <Suburb>sample string 14</Suburb>
  <UserGroupIDs>sample string 3</UserGroupIDs>
  <UserGroupTypeIDs>sample string 2</UserGroupTypeIDs>
  <UserName>sample string 8</UserName>
</ContactBasicSearchParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContactMatchBasicSelectWithDetailsVM

Name	Description	Type	Additional information
ContactList		Collection of ContactMatchBasicSelectWithDetails	None.
Response		IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ContactList": [
    {
      "AccountID": 1,
      "AccountName": "sample string 2",
      "AccountNumber": "sample string 3",
      "Balance": 1.0,
      "CloseDate": "2025-09-02T23:04:25.3502959+00:00",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "EntityName": "sample string 7",
      "Address": "sample string 8",
      "Postcode": "sample string 9",
      "State": "sample string 10",
      "Phone": "sample string 11",
      "ContactID": 12,
      "DOB": "2025-09-02T23:04:25.3502959+00:00"
    },
    {
      "AccountID": 1,
      "AccountName": "sample string 2",
      "AccountNumber": "sample string 3",
      "Balance": 1.0,
      "CloseDate": "2025-09-02T23:04:25.3502959+00:00",
      "FirstName": "sample string 4",
      "MiddleName": "sample string 5",
      "LastName": "sample string 6",
      "EntityName": "sample string 7",
      "Address": "sample string 8",
      "Postcode": "sample string 9",
      "State": "sample string 10",
      "Phone": "sample string 11",
      "ContactID": 12,
      "DOB": "2025-09-02T23:04:25.3502959+00:00"
    }
  ],
  "Response": null
}

application/xml, text/xml

Sample:

<ContactMatchBasicSelectWithDetailsVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Contact">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <ContactList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact">
    <d2p1:ContactMatchBasicSelectWithDetails>
      <d2p1:AccountID>1</d2p1:AccountID>
      <d2p1:AccountName>sample string 2</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 3</d2p1:AccountNumber>
      <d2p1:Address>sample string 8</d2p1:Address>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:CloseDate>2025-09-02T23:04:25.3502959+00:00</d2p1:CloseDate>
      <d2p1:ContactID>12</d2p1:ContactID>
      <d2p1:DOB>2025-09-02T23:04:25.3502959+00:00</d2p1:DOB>
      <d2p1:EntityName>sample string 7</d2p1:EntityName>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:LastName>sample string 6</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:Phone>sample string 11</d2p1:Phone>
      <d2p1:Postcode>sample string 9</d2p1:Postcode>
      <d2p1:State>sample string 10</d2p1:State>
    </d2p1:ContactMatchBasicSelectWithDetails>
    <d2p1:ContactMatchBasicSelectWithDetails>
      <d2p1:AccountID>1</d2p1:AccountID>
      <d2p1:AccountName>sample string 2</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 3</d2p1:AccountNumber>
      <d2p1:Address>sample string 8</d2p1:Address>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:CloseDate>2025-09-02T23:04:25.3502959+00:00</d2p1:CloseDate>
      <d2p1:ContactID>12</d2p1:ContactID>
      <d2p1:DOB>2025-09-02T23:04:25.3502959+00:00</d2p1:DOB>
      <d2p1:EntityName>sample string 7</d2p1:EntityName>
      <d2p1:FirstName>sample string 4</d2p1:FirstName>
      <d2p1:LastName>sample string 6</d2p1:LastName>
      <d2p1:MiddleName>sample string 5</d2p1:MiddleName>
      <d2p1:Phone>sample string 11</d2p1:Phone>
      <d2p1:Postcode>sample string 9</d2p1:Postcode>
      <d2p1:State>sample string 10</d2p1:State>
    </d2p1:ContactMatchBasicSelectWithDetails>
  </ContactList>
</ContactMatchBasicSelectWithDetailsVM>