address.validate

Input Specification

Field#	Name	Description
3		Required value "address.validate"
9		Selection predicates
120		Input address

Possible Predicates

Field#	Name	Description
121-129		Input address a line at a time. F121 is the first line through to F129 for the last line.
130		Current users Geo location. Supplied as (long,lat) eg "178.65,-41.4". Or long Only with lat in f131
131		User Current Geo Position LAT only eg "-41.4"
132		User Current Country (can be estimate such as IP geo locate)
133		Desired Output Language

Output Specification

The response packet from the server may include the following fields

Field#	Name	Description
105	Longitude	Longitude of the address.
106	Latitude	Latitude of the address.
107	Label	Address label that can be placed on the item. This is a pipe separated list. Where possible this is formatted to the target countries specifications
108	Pafid	A number unique identifying a delivery address. Only present for some countries
200	StreetNumber
201	StreetAlpha
202	UnitType
203	UnitIdent
204	Floor
205	Building
206	Street
207	StreetType
208	StreetDir
209	Box
210	Lobby
211	Suburb
212	TownCity
213	UnitType
214	Rural
215	Country

Examples

Validate an address, return response in JSON

http://...server.../gnap/J/buck?3=address.validate&120=123 Queen st


{ "RootType":"ARAY",
  "APPD":[ 
    {"Longitude":null,"Latitude":null,"Label":"123 Queen Street East|Hastings 4122"},
    {"Longitude":null,"Latitude":null,"Label":"Flat 1|123 Queen Street|Northcote Point|Auckland 0627"},
    {"Longitude":null,"Latitude":null,"Label":"Flat 2|123 Queen Street|Northcote Point|Auckland 0627"},
    {"Longitude":null,"Latitude":null,"Label":"123 Queen Street|Pukekohe 2120"},
    {"Longitude":null,"Latitude":null,"Label":"123 Queen Street|Palmerston North 4410"},
    {"Longitude":null,"Latitude":null,"Label":"123 Queen Street|Westport 7825"},
    {"Longitude":null,"Latitude":null,"Label":"Suite 1|123 Queen Street|Palmerston North 4410"}
  ]
}

Validate an address, return response in named XML

http://...server.../gnap/M/buck?3=address.validate&120=box 15232&120=miramar&7=100-230


<ARAY>
  <APPD>
    <MeshBlock/>
    <Longitude/>
    <Latitude/>
    <Label>PO Box 15232|Miramar|Wellington 6243</Label>
    <Pafid>6012269</Pafid>
    <StreetNumber>0</StreetNumber>
    <StreetAlpha>0</StreetAlpha>
    <UnitType/>
    <UnitIdent/>
    <Floor/>
    <Building/>
    <Street/>
    <StreetType/>
    <StreetDir/>
    <Box>15232</Box>
    <Lobby>Miramar</Lobby>
    <Suburb/>
    <TownCity>Wellington</TownCity>
    <UnitType>6243</UnitType>
    <Rural/>
    <Country/>
  </APPD>
</ARAY>