Difference between revisions of "XcelDataAPI:Version 0.2/standardize-address"

From XcelData Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
 +
== Main Entry Point ==
 +
{{main|XcelDataAPI:Version_0.2|XcelData API v0.2}}
  
 
== Example ==
 
== Example ==
Line 70: Line 73:
 
     <Result ID="1">
 
     <Result ID="1">
 
       <ID>1</ID>
 
       <ID>1</ID>
       <Address2>2118 F ST</Address2>
+
       <Address1>2118 F ST</Address1>
 
       <City>BAKERSFIELD</City>
 
       <City>BAKERSFIELD</City>
 
       <State>CA</State>
 
       <State>CA</State>
Line 78: Line 81:
 
     <Result ID="2">
 
     <Result ID="2">
 
       <ID>2</ID>
 
       <ID>2</ID>
       <Address1>STE 5</Address1>
+
       <Address1>5880 DISTRICT BLVD</Address1>
       <Address2>5880 DISTRICT BLVD</Address2>
+
       <Address2>STE 5</Address2>
 
       <City>BAKERSFIELD</City>
 
       <City>BAKERSFIELD</City>
 
       <State>CA</State>
 
       <State>CA</State>
Line 95: Line 98:
 
     {
 
     {
 
       "ID": "1",
 
       "ID": "1",
       "Address2": "2118 F ST",
+
       "Address1": "2118 F ST",
 
       "City": "BAKERSFIELD",
 
       "City": "BAKERSFIELD",
 
       "State": "CA",
 
       "State": "CA",
Line 103: Line 106:
 
     {
 
     {
 
       "ID": "2",
 
       "ID": "2",
       "Address1": "STE 5",
+
       "Address1": "5880 DISTRICT BLVD",
       "Address2": "5880 DISTRICT BLVD",
+
       "Address2": "STE 5",
 
       "City": "BAKERSFIELD",
 
       "City": "BAKERSFIELD",
 
       "State": "CA",
 
       "State": "CA",

Revision as of 22:47, 30 April 2018

Main Entry Point

Main Page: XcelData API v0.2

Example

This endpoint allows you to query multiple addresses at the same time.

Let's look up the work address currently located at: 2118 F St, Bakersfield, CA 93301 and the old address located at: 5880 District Blvd Ste 5, Bakersfield, CA 93301

Request

The incoming request can be in either XML or JSON format and should be post data (or alternatively if using application/x-www-form-urlencoded use the key "data" and pass it the xml or json as a string).

XML - /0.2/xml/api-key/standardize-address JSON - /0.2/json/api-key/standardize-address
<Requests>
  <Request ID="1">
    <Address1>2118 F St</Address1>
    <City>Bakersfield</City>
    <State>CA</State>
    <Zip5>93301</Zip5>
  </Request>
  <Request ID="2">
    <Address1>5880 District Blvd Ste 5</Address1>
    <City>Bakersfield</City>
    <State>CA</State>
    <Zip5>93313</Zip5>
  </Request>
</Requests>
{"Requests": [
  {
    "Address1": "2118 F St",
    "City": "Bakersfield",
    "ID": 1,
    "State": "CA",
    "Zip5": 93301
  },
  {
    "Address1": "5880 District Blvd Ste 5",
    "City": "Bakersfield",
    "ID": 1,
    "State": "CA",
    "Zip5": 93313
  }
]}

Output

The output can either be XML or JSON. You specify that in the request url.

XML - /0.2/xml/api-key/standardize-address JSON - /0.2/json/api-key/standardize-address
<?xml version="1.0"?>
<root>
  <success>1</success>
  <Results>
    <Result ID="1">
      <ID>1</ID>
      <Address1>2118 F ST</Address1>
      <City>BAKERSFIELD</City>
      <State>CA</State>
      <Zip5>93301</Zip5>
      <Zip4>3826</Zip4>
    </Result>
    <Result ID="2">
      <ID>2</ID>
      <Address1>5880 DISTRICT BLVD</Address1>
      <Address2>STE 5</Address2>
      <City>BAKERSFIELD</City>
      <State>CA</State>
      <Zip5>93313</Zip5>
      <Zip4>2138</Zip4>
    </Result>
  </Results>
</root>
{
  "success": true,
  "Results": [
    {
      "ID": "1",
      "Address1": "2118 F ST",
      "City": "BAKERSFIELD",
      "State": "CA",
      "Zip5": "93301",
      "Zip4": "3826"
    },
    {
      "ID": "2",
      "Address1": "5880 DISTRICT BLVD",
      "Address2": "STE 5",
      "City": "BAKERSFIELD",
      "State": "CA",
      "Zip5": "93313",
      "Zip4": "2138"
    }
  ]
}