Direct Integration API icon

Direct Integration API

(0 reviews)

Address

Sample Request

{
  "Package": {
    "Content": {
      "Application": {
        "Address": [
          {
            "Standard": {
              "@StreetName": "Peter",
              "@StreetNumber": "22",
              "@StreetType": "Terrace",
              "@BuildingName": "DC Residence",
              "@Level": "3",
              "@Unit": "10",
              "@StreetSuffix": "Central"
            },
            "@UniqueID": "aca611351c8b",
            "@Type": "Standard",
            "@Suburb": "Castor Bay",
            "@City": "Auckland",
            "@Country": "PH",
            "@NewZealandPostCode": "0620",
            "@OverseasPostCode": "Overseas",
            "@OverseasState": "Overseas"
          },
          {
            "NonStandard": {
              "@Line1": "281 Ohauiti Rd",
              "@Line2": "Test Line 2"
            },
            "@UniqueID": "d7c56ad47d43",
            "@Type": "Non Standard",
            "@Suburb": "Ohauiti",
            "@City": "Tarunga",
            "@Country": "NZ",
            "@NewZealandPostCode": "0620",
            "@OverseasPostCode": "Overseas",
            "@OverseasState": "Overseas"
          },
          {
            "POBox": {
              "@Exchange": "pobox123",
              "@Number": "pobox123",
              "@Type": "Response Bag"
            },
            "@UniqueID": "bb8930ecf34c",
            "@Type": "PO Box or Bag",
            "@Suburb": "Avondale",
            "@City": "Christchurch",
            "@Country": "NZ",
            "@NewZealandPostCode": "0620",
            "@OverseasPostCode": "Overseas",
            "@OverseasState": "Overseas"
          },
          {
            "DXBox": {
              "@Exchange": "dxbox123",
              "@Number": "dxbox123",
              "@Provider": "dxbox provider"
            },
            "@UniqueID": "ec0fb11a9603",
            "@Type": "DX Box",
            "@Suburb": "Chedworth",
            "@City": "Hamilton",
            "@Country": "JP",
            "@NewZealandPostCode": "0620",
            "@OverseasPostCode": "Overseas",
            "@OverseasState": "Overseas"
          }
        ]
      }
    }
  }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
AddressAny real or postal address, used by referenceobjectPackage.Content.Application.Address
@UniqueIDUnique identification assigned to this addressstringPackage.Content.Application.Address.UniqueIDYes
StandardThe standard addressobjectPackage.Content.Application.Address.Standard
@BuildingNameThe full name used to identify the physical building or property. Usually this information is not abbreviated. Should include any reference to a wing or other components of a building complex, if applicablestringPackage.Content.Application.Address.Standard.BuildingName
@LevelDescriptors used to identify the floor or level of a multi-storey building or complexstringPackage.Content.Application.Address.Standard.Level
@UnitThe specification of the type of a separately identifiable portion within a building complex or marina with its associated number or identifier to clearly distinguish it from another. Can either be depicted by numerals or alpha characters, or a mixture of bothstringPackage.Content.Application.Address.Standard.Unit
@StreetSuffixA suffix used to further describe the part of the address that offers directional information. For addresses in New Zealand, this attribute is used for the field referred to as street directionstringPackage.Content.Application.Address.Standard.StreetSuffixCentral, East, Extension, Lower, North, North East, North West, South, South East, South West, Upper, West
@StreetNumberTo record the numeric or numeric/alpha reference number of a house or propertystringPackage.Content.Application.Address.Standard.StreetNumberYes for Standard Address
@StreetNameThe full street name used to identify the street location of the propertystringPackage.Content.Application.Address.Standard.StreetNameYes for Standard Address
@StreetTypeUsed to identify the thoroughfare typestringPackage.Content.Application.Address.Standard.StreetTypeYes for Standard AddressAccess, Accessway, Alley, Anchorage, Approach, Arcade, Arch, Avenue, Bank, Bay, Beach, Belt, Bend, Bluff, Boulevard, Brae, Briars, Bridge, Bypass, Centre, Chase, Circle, Circus, Claim, Close, Common, Court, Courts, Cove, Creek, Crescent, Crest, Cul, Dale, Dell, Downs, Drive, Dune, Elm, End, Entrance, Esplanade, Estate, Fairway, Fall, Fare, Farms, Fen, Fern, Flat, Flats, Garden, Gardens, Gate, Glade, Glen, Grange, Green, Grovem Gully, Haven, Head, Heights, Highway, Hill, Island, Junction, Key, Knob, Ladder, Landing, Lane, Line, Link, Lookout, Loop, Mall, Mead, Meadows, Mews, Mile, Motorway, Motu, Mount, Neaves, Oaks, Paddock, Paku, Parade, Park, Parkway, Pass, Passage, Path, Place, Point, Priors, Promenade, Quadrant, Quay, Reef, Reserve, Rest, Retreat, Ridge, Rise, Road, Roads, Roadway, Route, Row, Service Lane, Slope, Spa, Spur, Square, State Highway, Steep, Steps, Straight, Strand, Street, Terrace, Towers, Track, Trail, Tramway, Trees, Vale, Valley, Venus, View, Views, Village, Villas, Vista, Vue, Walk, Waters, Way, Wharf, Wynd
@OverseasPostCodeA series of letters and/or digits for a postal delivery area overseasstringPackage.Content.Application.Address.OverseasPostCodeYes if Overseas state exist and country is not NZ
@OverseasStateThe State, Province or Territory overseas that the specific placename/address is locatedstringPackage.Content.Application.Address.OverseasState
NonStandardThe non standard addressobjectPackage.Content.Application.Address.NonStandaerd
@Line1Line 1 of the addressstringPackage.Content.Application.Address.NonStandard.Line1Yes for non standard address
@Line2Line 2 of the addressstringPackage.Content.Application.Address.NonStandard.Line2
POBoxThe standard PO Box addressobjectPackage.Content.Application.Address.POBox
@ExchangeAn exchange box in an authorised PO systemstringPackage.Content.Application.Address.POBox.ExchangeYes if type is POBox
@NumberAn identification number, forming part of an address, for the channel of postal deliverystringPackage.Content.Application.Address.POBox.NumberYes if type is POBox
@TypeThe specification of the identification of a postal delivery service such as General Post Office Box, Community Mail Bag, etc. to clearly distinguish it from another when applicablestringPackage.Content.Application.Address.POBox.TypeCommunity Mail Bag, Counter Delivery, PO Box, Poste Restante, Private Bag, Response Bag
DXBoxThe DX Box addressobjectPackage.Content.Application.Address.DXBox
@ExchangeAn exchange box in an authorised DX systemstringPackage.Content.Application.Address.DXBox.ExchangeYes if type is DXBox
@NumberAn identification number, used for tracking the documents from the moment they're collected to the time they arrive at their destinationstringPackage.Content.Application.Address.DXBox.NumberYes if type is DXBox
@ProviderThe name of the company providing DX mailing servicesstringPackage.Content.Application.Address.DXBox.Provider
@TypeDetermines if the address is Standard, Non Standard, a DX Box or a PO BOXstringPackage.Content.Application.Address.TypeYesDX Box, Non Standard, PO Box or Bag, Standard
@SuburbThe full name of the placename or Post Office of delivery containing the specific address, which may include a Delivery Centre or a Business CentrestringPackage.Content.Application.Address.SuburbYes
@CityThe name of the town, city or island the delivery point is located in or associated with. Australian addresses do not have a City as per Australia Post guidelines. According to New Zealand Post Address Standards, the Town/City is a mandatory element of all addresses, i.e. urban, rural and delivery service addressesstringPackage.Content.Application.Address.CityYes
@NewZealandPostCodeA four digit numeric descriptor for a postal delivery area, aligned with placename, suburb or locality and in some circumstances a unique Postal Delivery TypestringPackage.Content.Application.Address.NewZealandPostCodeYes (only if Country is NZ)
@CountryThe destination country of the addressstringPackage.Content.Application.Address.CountryYesAD,AE,AF,AG,AI,AL,AM,AO,AQ,AR,AS,AT,AU,AW,AX,AZ,BA,BB,BD,BE,BF,BG,BH,BI,BJ,BL,BM,BN,BO,BQ,BR,BS,BT,BV,BW,BY,BZ,CA,CC,CD,CF,CG,CH,CI,CK,CL,CM,CN,CO,CR,CU,CV,CW,CX,CY,CZ,DE,DJ,DK,DM,DO,DZ,EC,EE,EG,EH,EH,ER,ES,ET,FI,FJ,FK,FM,FO,FR,GA,GB,GD,GE,GF,GG,GH,GI,GL,GM,GN,GP,GQ,GR,GS,GT,GU,GW,GY,HK,HM,HN,HR,HT,HU,ID,IE,IL,IM,IN,IO,IQ,IR,IS,IT,JE,JM,JO,JP,KE,KG,KH,KI,KM,KN,KP,KR,KW,KY,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,LY,MA,MC,MD,ME,MF,MG,MH,MK,ML,MM,MN,MO,MP,MQ,MR,MS,MT,MU,MV,MW,MX,MY,MZ,NA,NC,NE,NF,NG,NI,NL,NO,NP,NR,NU,NZ,OM,PA,PE,PF,PG,PH,PK,PL,PM,PN,PR,PS,PT,PW,PY,QA,RE,RO,RS,RU,RW,SA,SB,SC,SD,SE,SG,SH,SI,SJ,SK,SL,SM,SN,SO,SR,SS,ST,SV,SX,SY,SZ,TC,TD,TF,TG,TH,TJ,TK,TL,TM,TN,TO,TR,TT,TV,TW,TZ,UA,UG,UM,US,UY,UZ,VA,VC,VE,VG,VI,VN,VU,WF,WS,XK,YE,YT,ZA,ZM,ZW

Reviews