POST api/SearchDPSIDAddress

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
searchDPSIDAddressRequest
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "BusinessAPIkey": "sample string 1",
  "SearchKeyWord": "sample string 2",
  "page_number": "sample string 3",
  "per_page": "sample string 4"
}

application/xml, text/xml

Sample:
<SearchDPSIDAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPSID_API.Models">
  <BusinessAPIkey>sample string 1</BusinessAPIkey>
  <SearchKeyWord>sample string 2</SearchKeyWord>
  <page_number>sample string 3</page_number>
  <per_page>sample string 4</per_page>
</SearchDPSIDAddressRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "ErrorCode": "sample string 1",
  "PageNumber": "sample string 2",
  "Pages": "sample string 3",
  "PerPage": "sample string 4",
  "Total": "sample string 5",
  "MyCurrentAddresses": [
    {
      "Email": "sample string 1",
      "TeleCellCountryCode": "sample string 2",
      "TeleCell": "sample string 3",
      "TeleCell2": "sample string 4",
      "TeleCell3": "sample string 5",
      "TeleCell4": "sample string 6",
      "TeleHome": "sample string 7",
      "WebPageURL": "sample string 8",
      "AnyReferenceNo": "sample string 9",
      "DPSID": "sample string 10",
      "FirstName": "sample string 11",
      "MiddleName": "sample string 12",
      "LastName": "sample string 13",
      "CurrentAddressType": "sample string 14",
      "IsSecured": true,
      "IsAddressVerified": true,
      "Street1": "sample string 17",
      "Street2": "sample string 18",
      "Street3": "sample string 19",
      "Street4": "sample string 20",
      "City": "sample string 21",
      "State": "sample string 22",
      "CountryName": "sample string 23",
      "Zip": "sample string 24",
      "StartDate": "sample string 25",
      "EndDate": "sample string 26",
      "DateLastModified": "sample string 27",
      "IsAccess": "sample string 28",
      "DisplayName": "sample string 29",
      "ImagePath": "sample string 30"
    },
    {
      "Email": "sample string 1",
      "TeleCellCountryCode": "sample string 2",
      "TeleCell": "sample string 3",
      "TeleCell2": "sample string 4",
      "TeleCell3": "sample string 5",
      "TeleCell4": "sample string 6",
      "TeleHome": "sample string 7",
      "WebPageURL": "sample string 8",
      "AnyReferenceNo": "sample string 9",
      "DPSID": "sample string 10",
      "FirstName": "sample string 11",
      "MiddleName": "sample string 12",
      "LastName": "sample string 13",
      "CurrentAddressType": "sample string 14",
      "IsSecured": true,
      "IsAddressVerified": true,
      "Street1": "sample string 17",
      "Street2": "sample string 18",
      "Street3": "sample string 19",
      "Street4": "sample string 20",
      "City": "sample string 21",
      "State": "sample string 22",
      "CountryName": "sample string 23",
      "Zip": "sample string 24",
      "StartDate": "sample string 25",
      "EndDate": "sample string 26",
      "DateLastModified": "sample string 27",
      "IsAccess": "sample string 28",
      "DisplayName": "sample string 29",
      "ImagePath": "sample string 30"
    },
    {
      "Email": "sample string 1",
      "TeleCellCountryCode": "sample string 2",
      "TeleCell": "sample string 3",
      "TeleCell2": "sample string 4",
      "TeleCell3": "sample string 5",
      "TeleCell4": "sample string 6",
      "TeleHome": "sample string 7",
      "WebPageURL": "sample string 8",
      "AnyReferenceNo": "sample string 9",
      "DPSID": "sample string 10",
      "FirstName": "sample string 11",
      "MiddleName": "sample string 12",
      "LastName": "sample string 13",
      "CurrentAddressType": "sample string 14",
      "IsSecured": true,
      "IsAddressVerified": true,
      "Street1": "sample string 17",
      "Street2": "sample string 18",
      "Street3": "sample string 19",
      "Street4": "sample string 20",
      "City": "sample string 21",
      "State": "sample string 22",
      "CountryName": "sample string 23",
      "Zip": "sample string 24",
      "StartDate": "sample string 25",
      "EndDate": "sample string 26",
      "DateLastModified": "sample string 27",
      "IsAccess": "sample string 28",
      "DisplayName": "sample string 29",
      "ImagePath": "sample string 30"
    }
  ]
}

application/xml, text/xml

Sample:
<DPSID_MyAddresses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dpsid.Models">
  <ErrorCode>sample string 1</ErrorCode>
  <MyCurrentAddresses>
    <MyCurrentAddress>
      <AnyReferenceNo>sample string 9</AnyReferenceNo>
      <City>sample string 21</City>
      <CountryName>sample string 23</CountryName>
      <CurrentAddressType>sample string 14</CurrentAddressType>
      <DPSID>sample string 10</DPSID>
      <DateLastModified>sample string 27</DateLastModified>
      <DisplayName>sample string 29</DisplayName>
      <Email>sample string 1</Email>
      <EndDate>sample string 26</EndDate>
      <FirstName>sample string 11</FirstName>
      <ImagePath>sample string 30</ImagePath>
      <IsAccess>sample string 28</IsAccess>
      <IsAddressVerified>true</IsAddressVerified>
      <IsSecured>true</IsSecured>
      <LastName>sample string 13</LastName>
      <MiddleName>sample string 12</MiddleName>
      <StartDate>sample string 25</StartDate>
      <State>sample string 22</State>
      <Street1>sample string 17</Street1>
      <Street2>sample string 18</Street2>
      <Street3>sample string 19</Street3>
      <Street4>sample string 20</Street4>
      <TeleCell>sample string 3</TeleCell>
      <TeleCell2>sample string 4</TeleCell2>
      <TeleCell3>sample string 5</TeleCell3>
      <TeleCell4>sample string 6</TeleCell4>
      <TeleCellCountryCode>sample string 2</TeleCellCountryCode>
      <TeleHome>sample string 7</TeleHome>
      <WebPageURL>sample string 8</WebPageURL>
      <Zip>sample string 24</Zip>
    </MyCurrentAddress>
    <MyCurrentAddress>
      <AnyReferenceNo>sample string 9</AnyReferenceNo>
      <City>sample string 21</City>
      <CountryName>sample string 23</CountryName>
      <CurrentAddressType>sample string 14</CurrentAddressType>
      <DPSID>sample string 10</DPSID>
      <DateLastModified>sample string 27</DateLastModified>
      <DisplayName>sample string 29</DisplayName>
      <Email>sample string 1</Email>
      <EndDate>sample string 26</EndDate>
      <FirstName>sample string 11</FirstName>
      <ImagePath>sample string 30</ImagePath>
      <IsAccess>sample string 28</IsAccess>
      <IsAddressVerified>true</IsAddressVerified>
      <IsSecured>true</IsSecured>
      <LastName>sample string 13</LastName>
      <MiddleName>sample string 12</MiddleName>
      <StartDate>sample string 25</StartDate>
      <State>sample string 22</State>
      <Street1>sample string 17</Street1>
      <Street2>sample string 18</Street2>
      <Street3>sample string 19</Street3>
      <Street4>sample string 20</Street4>
      <TeleCell>sample string 3</TeleCell>
      <TeleCell2>sample string 4</TeleCell2>
      <TeleCell3>sample string 5</TeleCell3>
      <TeleCell4>sample string 6</TeleCell4>
      <TeleCellCountryCode>sample string 2</TeleCellCountryCode>
      <TeleHome>sample string 7</TeleHome>
      <WebPageURL>sample string 8</WebPageURL>
      <Zip>sample string 24</Zip>
    </MyCurrentAddress>
    <MyCurrentAddress>
      <AnyReferenceNo>sample string 9</AnyReferenceNo>
      <City>sample string 21</City>
      <CountryName>sample string 23</CountryName>
      <CurrentAddressType>sample string 14</CurrentAddressType>
      <DPSID>sample string 10</DPSID>
      <DateLastModified>sample string 27</DateLastModified>
      <DisplayName>sample string 29</DisplayName>
      <Email>sample string 1</Email>
      <EndDate>sample string 26</EndDate>
      <FirstName>sample string 11</FirstName>
      <ImagePath>sample string 30</ImagePath>
      <IsAccess>sample string 28</IsAccess>
      <IsAddressVerified>true</IsAddressVerified>
      <IsSecured>true</IsSecured>
      <LastName>sample string 13</LastName>
      <MiddleName>sample string 12</MiddleName>
      <StartDate>sample string 25</StartDate>
      <State>sample string 22</State>
      <Street1>sample string 17</Street1>
      <Street2>sample string 18</Street2>
      <Street3>sample string 19</Street3>
      <Street4>sample string 20</Street4>
      <TeleCell>sample string 3</TeleCell>
      <TeleCell2>sample string 4</TeleCell2>
      <TeleCell3>sample string 5</TeleCell3>
      <TeleCell4>sample string 6</TeleCell4>
      <TeleCellCountryCode>sample string 2</TeleCellCountryCode>
      <TeleHome>sample string 7</TeleHome>
      <WebPageURL>sample string 8</WebPageURL>
      <Zip>sample string 24</Zip>
    </MyCurrentAddress>
  </MyCurrentAddresses>
  <PageNumber>sample string 2</PageNumber>
  <Pages>sample string 3</Pages>
  <PerPage>sample string 4</PerPage>
  <Total>sample string 5</Total>
</DPSID_MyAddresses>