RightAddressSvc Web Service

RightAddressSvc

Click here for a complete list of operations.

CanonicalFormatAddress2

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
Token:
KeyCode:
Active:
Format:
Line1:
Line2:
Line3:
Line4:
Line5:
Line6:
Line7:
PostCode:
Country:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /rightaddress.asmx HTTP/1.1
Host: rightaddress.simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://rightaddress.simplicitycrm.com/CanonicalFormatAddress2"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CanonicalFormatAddress2 xmlns="http://rightaddress.simplicitycrm.com">
      <Token>string</Token>
      <KeyCode>string</KeyCode>
      <Active>boolean</Active>
      <Format>Canonical or StreetComponentsOnly or LocalityComponentsOnSeparateLines or Default</Format>
      <Line1>string</Line1>
      <Line2>string</Line2>
      <Line3>string</Line3>
      <Line4>string</Line4>
      <Line5>string</Line5>
      <Line6>string</Line6>
      <Line7>string</Line7>
      <PostCode>string</PostCode>
      <Country>string</Country>
    </CanonicalFormatAddress2>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CanonicalFormatAddress2Response xmlns="http://rightaddress.simplicitycrm.com">
      <CanonicalFormatAddress2Result>
        <Line1>string</Line1>
        <Line2>string</Line2>
        <Line3>string</Line3>
        <Line4>string</Line4>
        <Line5>string</Line5>
        <Line6>string</Line6>
        <Line7>string</Line7>
        <Country>string</Country>
        <PostCode>string</PostCode>
        <DPID>string</DPID>
        <StreetName>string</StreetName>
        <StreetNumber>string</StreetNumber>
        <StreetType>string</StreetType>
        <StreetTypeSuffix>string</StreetTypeSuffix>
        <Suburb>string</Suburb>
        <TownOrCity>string</TownOrCity>
        <PostalDeliveryType>string</PostalDeliveryType>
        <PostalDeliveryNumber>string</PostalDeliveryNumber>
        <RuralDeliveryNumber>string</RuralDeliveryNumber>
        <MeshBlock>int</MeshBlock>
        <Longitude>double</Longitude>
        <Latitude>double</Latitude>
        <MapGrid_X>int</MapGrid_X>
        <MapGrid_Y>int</MapGrid_Y>
        <RegionCode>string</RegionCode>
        <RegionName>string</RegionName>
        <AreaUnitCode>string</AreaUnitCode>
        <AreaUnitName>string</AreaUnitName>
        <TerritoryCode>string</TerritoryCode>
        <TerritoryName>string</TerritoryName>
        <FormatFlag>boolean</FormatFlag>
        <ErrorCode>int</ErrorCode>
        <ErrorReason>string</ErrorReason>
        <CorrectionCode>string</CorrectionCode>
        <StatementOfAccuracyCode>string</StatementOfAccuracyCode>
        <StatementOfAccuracyReason>string</StatementOfAccuracyReason>
      </CanonicalFormatAddress2Result>
    </CanonicalFormatAddress2Response>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /rightaddress.asmx HTTP/1.1
Host: rightaddress.simplicitycrm.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CanonicalFormatAddress2 xmlns="http://rightaddress.simplicitycrm.com">
      <Token>string</Token>
      <KeyCode>string</KeyCode>
      <Active>boolean</Active>
      <Format>Canonical or StreetComponentsOnly or LocalityComponentsOnSeparateLines or Default</Format>
      <Line1>string</Line1>
      <Line2>string</Line2>
      <Line3>string</Line3>
      <Line4>string</Line4>
      <Line5>string</Line5>
      <Line6>string</Line6>
      <Line7>string</Line7>
      <PostCode>string</PostCode>
      <Country>string</Country>
    </CanonicalFormatAddress2>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CanonicalFormatAddress2Response xmlns="http://rightaddress.simplicitycrm.com">
      <CanonicalFormatAddress2Result>
        <Line1>string</Line1>
        <Line2>string</Line2>
        <Line3>string</Line3>
        <Line4>string</Line4>
        <Line5>string</Line5>
        <Line6>string</Line6>
        <Line7>string</Line7>
        <Country>string</Country>
        <PostCode>string</PostCode>
        <DPID>string</DPID>
        <StreetName>string</StreetName>
        <StreetNumber>string</StreetNumber>
        <StreetType>string</StreetType>
        <StreetTypeSuffix>string</StreetTypeSuffix>
        <Suburb>string</Suburb>
        <TownOrCity>string</TownOrCity>
        <PostalDeliveryType>string</PostalDeliveryType>
        <PostalDeliveryNumber>string</PostalDeliveryNumber>
        <RuralDeliveryNumber>string</RuralDeliveryNumber>
        <MeshBlock>int</MeshBlock>
        <Longitude>double</Longitude>
        <Latitude>double</Latitude>
        <MapGrid_X>int</MapGrid_X>
        <MapGrid_Y>int</MapGrid_Y>
        <RegionCode>string</RegionCode>
        <RegionName>string</RegionName>
        <AreaUnitCode>string</AreaUnitCode>
        <AreaUnitName>string</AreaUnitName>
        <TerritoryCode>string</TerritoryCode>
        <TerritoryName>string</TerritoryName>
        <FormatFlag>boolean</FormatFlag>
        <ErrorCode>int</ErrorCode>
        <ErrorReason>string</ErrorReason>
        <CorrectionCode>string</CorrectionCode>
        <StatementOfAccuracyCode>string</StatementOfAccuracyCode>
        <StatementOfAccuracyReason>string</StatementOfAccuracyReason>
      </CanonicalFormatAddress2Result>
    </CanonicalFormatAddress2Response>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /rightaddress.asmx/CanonicalFormatAddress2?Token=string&KeyCode=string&Active=string&Format=string&Line1=string&Line2=string&Line3=string&Line4=string&Line5=string&Line6=string&Line7=string&PostCode=string&Country=string HTTP/1.1
Host: rightaddress.simplicitycrm.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://rightaddress.simplicitycrm.com">
  <Line1>string</Line1>
  <Line2>string</Line2>
  <Line3>string</Line3>
  <Line4>string</Line4>
  <Line5>string</Line5>
  <Line6>string</Line6>
  <Line7>string</Line7>
  <Country>string</Country>
  <PostCode>string</PostCode>
  <DPID>string</DPID>
  <StreetName>string</StreetName>
  <StreetNumber>string</StreetNumber>
  <StreetType>string</StreetType>
  <StreetTypeSuffix>string</StreetTypeSuffix>
  <Suburb>string</Suburb>
  <TownOrCity>string</TownOrCity>
  <PostalDeliveryType>string</PostalDeliveryType>
  <PostalDeliveryNumber>string</PostalDeliveryNumber>
  <RuralDeliveryNumber>string</RuralDeliveryNumber>
  <MeshBlock>int</MeshBlock>
  <Longitude>double</Longitude>
  <Latitude>double</Latitude>
  <MapGrid_X>int</MapGrid_X>
  <MapGrid_Y>int</MapGrid_Y>
  <RegionCode>string</RegionCode>
  <RegionName>string</RegionName>
  <AreaUnitCode>string</AreaUnitCode>
  <AreaUnitName>string</AreaUnitName>
  <TerritoryCode>string</TerritoryCode>
  <TerritoryName>string</TerritoryName>
  <FormatFlag>boolean</FormatFlag>
  <ErrorCode>int</ErrorCode>
  <ErrorReason>string</ErrorReason>
  <CorrectionCode>string</CorrectionCode>
  <StatementOfAccuracyCode>string</StatementOfAccuracyCode>
  <StatementOfAccuracyReason>string</StatementOfAccuracyReason>
</Address>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /rightaddress.asmx/CanonicalFormatAddress2 HTTP/1.1
Host: rightaddress.simplicitycrm.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Token=string&KeyCode=string&Active=string&Format=string&Line1=string&Line2=string&Line3=string&Line4=string&Line5=string&Line6=string&Line7=string&PostCode=string&Country=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://rightaddress.simplicitycrm.com">
  <Line1>string</Line1>
  <Line2>string</Line2>
  <Line3>string</Line3>
  <Line4>string</Line4>
  <Line5>string</Line5>
  <Line6>string</Line6>
  <Line7>string</Line7>
  <Country>string</Country>
  <PostCode>string</PostCode>
  <DPID>string</DPID>
  <StreetName>string</StreetName>
  <StreetNumber>string</StreetNumber>
  <StreetType>string</StreetType>
  <StreetTypeSuffix>string</StreetTypeSuffix>
  <Suburb>string</Suburb>
  <TownOrCity>string</TownOrCity>
  <PostalDeliveryType>string</PostalDeliveryType>
  <PostalDeliveryNumber>string</PostalDeliveryNumber>
  <RuralDeliveryNumber>string</RuralDeliveryNumber>
  <MeshBlock>int</MeshBlock>
  <Longitude>double</Longitude>
  <Latitude>double</Latitude>
  <MapGrid_X>int</MapGrid_X>
  <MapGrid_Y>int</MapGrid_Y>
  <RegionCode>string</RegionCode>
  <RegionName>string</RegionName>
  <AreaUnitCode>string</AreaUnitCode>
  <AreaUnitName>string</AreaUnitName>
  <TerritoryCode>string</TerritoryCode>
  <TerritoryName>string</TerritoryName>
  <FormatFlag>boolean</FormatFlag>
  <ErrorCode>int</ErrorCode>
  <ErrorReason>string</ErrorReason>
  <CorrectionCode>string</CorrectionCode>
  <StatementOfAccuracyCode>string</StatementOfAccuracyCode>
  <StatementOfAccuracyReason>string</StatementOfAccuracyReason>
</Address>