POST api/address/GetAddressInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
processingOptions	AddressProcessingOptions	None.
address	Address	None.
securityKey	string	None.
tranId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "processingOptionsField": {
    "geoPositionField": true,
    "geoPositionFieldSpecified": true,
    "parsedAddressField": true,
    "parsedAddressFieldSpecified": true,
    "censusDataField": true,
    "censusDataFieldSpecified": true,
    "timeZoneDataField": true,
    "timeZoneDataFieldSpecified": true,
    "uppercaseField": true,
    "uppercaseFieldSpecified": true,
    "cassOnlyField": true,
    "cassOnlyFieldSpecified": true,
    "watershedsField": true,
    "watershedsFieldSpecified": true
  },
  "addressField": {
    "addressLineField": "sample string 1",
    "neighborhoodField": "sample string 2",
    "cityField": "sample string 3",
    "stateProvField": "sample string 4",
    "postalZoneField": "sample string 5",
    "countyField": "sample string 6",
    "countryField": "sample string 7"
  },
  "securityKeyField": "sample string 1",
  "tranIdField": "sample string 2"
}

application/xml, text/xml

Sample:

<GetAddressInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.svm.webapi.address.SOAServiceReference">
  <addressField>
    <addressLineField>sample string 1</addressLineField>
    <cityField>sample string 3</cityField>
    <countryField>sample string 7</countryField>
    <countyField>sample string 6</countyField>
    <neighborhoodField>sample string 2</neighborhoodField>
    <postalZoneField>sample string 5</postalZoneField>
    <stateProvField>sample string 4</stateProvField>
  </addressField>
  <processingOptionsField>
    <cassOnlyField>true</cassOnlyField>
    <cassOnlyFieldSpecified>true</cassOnlyFieldSpecified>
    <censusDataField>true</censusDataField>
    <censusDataFieldSpecified>true</censusDataFieldSpecified>
    <geoPositionField>true</geoPositionField>
    <geoPositionFieldSpecified>true</geoPositionFieldSpecified>
    <parsedAddressField>true</parsedAddressField>
    <parsedAddressFieldSpecified>true</parsedAddressFieldSpecified>
    <timeZoneDataField>true</timeZoneDataField>
    <timeZoneDataFieldSpecified>true</timeZoneDataFieldSpecified>
    <uppercaseField>true</uppercaseField>
    <uppercaseFieldSpecified>true</uppercaseFieldSpecified>
    <watershedsField>true</watershedsField>
    <watershedsFieldSpecified>true</watershedsFieldSpecified>
  </processingOptionsField>
  <securityKeyField>sample string 1</securityKeyField>
  <tranIdField>sample string 2</tranIdField>
</GetAddressInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAddressInfoResponse

Name	Type	Additional information
result	Result	None.
correctedAddress	CorrectedAddress	None.
geoPosition	GeoPosition	None.
parsedAddress	ParsedAddress	None.
censusData	CensusData	None.
timeZoneData	TimeZoneData	None.
watershedData	WatershedData	None.
tranId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "resultField": {
    "detailMessageField": "sample string 1",
    "codeField": 2,
    "messageField": "sample string 3"
  },
  "correctedAddressField": {
    "statusField": "sample string 1",
    "addressLineField": "sample string 2",
    "neighborhoodField": "sample string 3",
    "cityField": "sample string 4",
    "stateProvField": "sample string 5",
    "postalZoneField": "sample string 6",
    "countyField": "sample string 7",
    "countryField": "sample string 8",
    "typeField": "sample string 9"
  },
  "geoPositionField": {
    "statusField": "sample string 1",
    "latitudeField": 2.1,
    "latitudeFieldSpecified": true,
    "longitudeField": 4.1,
    "longitudeFieldSpecified": true,
    "altitudeField": 6.1,
    "altitudeFieldSpecified": true,
    "precisionField": "sample string 8"
  },
  "parsedAddressField": {
    "houseNumberField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "preDirectField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "streetNameField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "streetSuffixField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "postDirectField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "unitTypeField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "unitNumberField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "neighborhoodField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "stateProvField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "postalZoneField": {
      "statusField": "sample string 1",
      "zip5Field": "sample string 2",
      "zip4Field": "sample string 3",
      "valueField": "sample string 4"
    },
    "urbanNameField": {
      "statusField": "sample string 1",
      "valueField": "sample string 2"
    },
    "countyField": {
      "statusField": "sample string 1",
      "fipsField": "sample string 2",
      "valueField": "sample string 3"
    },
    "statusField": "sample string 1",
    "typeField": "sample string 2"
  },
  "censusDataField": {
    "statusField": "sample string 1",
    "tractField": "sample string 2",
    "blockGroupField": "sample string 3",
    "blockIdField": "sample string 4",
    "msaNameField": "sample string 5",
    "msaNumberField": "sample string 6"
  },
  "timeZoneDataField": {
    "standardTransitionField": {
      "nameField": "sample string 1",
      "transitionMonthField": 2,
      "transitionMonthFieldSpecified": true,
      "transitionWeekField": 4,
      "transitionWeekFieldSpecified": true,
      "transitionDayOfWeekField": 6,
      "transitionDayOfWeekFieldSpecified": true,
      "transitionTimeField": "sample string 8"
    },
    "daylightTransitionField": {
      "nameField": "sample string 1",
      "transitionMonthField": 2,
      "transitionMonthFieldSpecified": true,
      "transitionWeekField": 4,
      "transitionWeekFieldSpecified": true,
      "transitionDayOfWeekField": 6,
      "transitionDayOfWeekFieldSpecified": true,
      "transitionTimeField": "sample string 8"
    },
    "statusField": "sample string 1",
    "standardGmtOffsetField": 2.1,
    "observesDstField": true,
    "standardNameField": "sample string 4",
    "daylightNameField": "sample string 5"
  },
  "watershedDataField": {
    "shapeInfosField": [
      {
        "shapePropertiesField": [
          {
            "nameField": "sample string 1",
            "valueField": "sample string 2"
          },
          {
            "nameField": "sample string 1",
            "valueField": "sample string 2"
          }
        ],
        "propertyCountField": 1
      },
      {
        "shapePropertiesField": [
          {
            "nameField": "sample string 1",
            "valueField": "sample string 2"
          },
          {
            "nameField": "sample string 1",
            "valueField": "sample string 2"
          }
        ],
        "propertyCountField": 1
      }
    ],
    "statusField": "sample string 1",
    "watershedCountField": 2
  },
  "tranIdField": "sample string 1"
}

application/xml, text/xml

Sample:

<GetAddressInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.svm.webapi.address.SOAServiceReference">
  <censusDataField>
    <blockGroupField>sample string 3</blockGroupField>
    <blockIdField>sample string 4</blockIdField>
    <msaNameField>sample string 5</msaNameField>
    <msaNumberField>sample string 6</msaNumberField>
    <statusField>sample string 1</statusField>
    <tractField>sample string 2</tractField>
  </censusDataField>
  <correctedAddressField>
    <addressLineField>sample string 2</addressLineField>
    <cityField>sample string 4</cityField>
    <countryField>sample string 8</countryField>
    <countyField>sample string 7</countyField>
    <neighborhoodField>sample string 3</neighborhoodField>
    <postalZoneField>sample string 6</postalZoneField>
    <stateProvField>sample string 5</stateProvField>
    <statusField>sample string 1</statusField>
    <typeField>sample string 9</typeField>
  </correctedAddressField>
  <geoPositionField>
    <altitudeField>6.1</altitudeField>
    <altitudeFieldSpecified>true</altitudeFieldSpecified>
    <latitudeField>2.1</latitudeField>
    <latitudeFieldSpecified>true</latitudeFieldSpecified>
    <longitudeField>4.1</longitudeField>
    <longitudeFieldSpecified>true</longitudeFieldSpecified>
    <precisionField>sample string 8</precisionField>
    <statusField>sample string 1</statusField>
  </geoPositionField>
  <parsedAddressField>
    <countyField>
      <fipsField>sample string 2</fipsField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 3</valueField>
    </countyField>
    <houseNumberField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </houseNumberField>
    <neighborhoodField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </neighborhoodField>
    <postDirectField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </postDirectField>
    <postalZoneField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 4</valueField>
      <zip4Field>sample string 3</zip4Field>
      <zip5Field>sample string 2</zip5Field>
    </postalZoneField>
    <preDirectField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </preDirectField>
    <stateProvField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </stateProvField>
    <statusField>sample string 1</statusField>
    <streetNameField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </streetNameField>
    <streetSuffixField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </streetSuffixField>
    <typeField>sample string 2</typeField>
    <unitNumberField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </unitNumberField>
    <unitTypeField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </unitTypeField>
    <urbanNameField>
      <statusField>sample string 1</statusField>
      <valueField>sample string 2</valueField>
    </urbanNameField>
  </parsedAddressField>
  <resultField>
    <codeField>2</codeField>
    <detailMessageField>sample string 1</detailMessageField>
    <messageField>sample string 3</messageField>
  </resultField>
  <timeZoneDataField>
    <daylightNameField>sample string 5</daylightNameField>
    <daylightTransitionField>
      <nameField>sample string 1</nameField>
      <transitionDayOfWeekField>6</transitionDayOfWeekField>
      <transitionDayOfWeekFieldSpecified>true</transitionDayOfWeekFieldSpecified>
      <transitionMonthField>2</transitionMonthField>
      <transitionMonthFieldSpecified>true</transitionMonthFieldSpecified>
      <transitionTimeField>sample string 8</transitionTimeField>
      <transitionWeekField>4</transitionWeekField>
      <transitionWeekFieldSpecified>true</transitionWeekFieldSpecified>
    </daylightTransitionField>
    <observesDstField>true</observesDstField>
    <standardGmtOffsetField>2.1</standardGmtOffsetField>
    <standardNameField>sample string 4</standardNameField>
    <standardTransitionField>
      <nameField>sample string 1</nameField>
      <transitionDayOfWeekField>6</transitionDayOfWeekField>
      <transitionDayOfWeekFieldSpecified>true</transitionDayOfWeekFieldSpecified>
      <transitionMonthField>2</transitionMonthField>
      <transitionMonthFieldSpecified>true</transitionMonthFieldSpecified>
      <transitionTimeField>sample string 8</transitionTimeField>
      <transitionWeekField>4</transitionWeekField>
      <transitionWeekFieldSpecified>true</transitionWeekFieldSpecified>
    </standardTransitionField>
    <statusField>sample string 1</statusField>
  </timeZoneDataField>
  <tranIdField>sample string 1</tranIdField>
  <watershedDataField>
    <shapeInfosField>
      <ShapeInfo>
        <propertyCountField>1</propertyCountField>
        <shapePropertiesField>
          <ShapeProperty>
            <nameField>sample string 1</nameField>
            <valueField>sample string 2</valueField>
          </ShapeProperty>
          <ShapeProperty>
            <nameField>sample string 1</nameField>
            <valueField>sample string 2</valueField>
          </ShapeProperty>
        </shapePropertiesField>
      </ShapeInfo>
      <ShapeInfo>
        <propertyCountField>1</propertyCountField>
        <shapePropertiesField>
          <ShapeProperty>
            <nameField>sample string 1</nameField>
            <valueField>sample string 2</valueField>
          </ShapeProperty>
          <ShapeProperty>
            <nameField>sample string 1</nameField>
            <valueField>sample string 2</valueField>
          </ShapeProperty>
        </shapePropertiesField>
      </ShapeInfo>
    </shapeInfosField>
    <statusField>sample string 1</statusField>
    <watershedCountField>2</watershedCountField>
  </watershedDataField>
</GetAddressInfoResponse>