Express Entry:Global JSON Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
Edward (talk | contribs)
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{ExpressEntryNav
{{ExpressEntryNav
|ResponseCollapse=
|ExamplesCollapse=
}}
}}


Line 8: Line 8:
<pre>
<pre>
{
{
   “Version”:”String Content”,
   "Version":"string",
   “ResultCode”:”String Content”,
   "ResultCode":"string",
   “ErrorString”:”String Content”,
   "ErrorString":"string",
   “Results”:[{
   "Results":[{
     “Address”:{
     "Address":{
       “Address”:”String Content”,
       "Address":"string",
       “Address1”:”String Content”,
       "Address1":"string",
       “Address2”:”String Content”,
       "Address2":"string",
       “Address3”:”String Content”,
       "Address3":"string",
       “Address4”:”String Content”,
       "Address4":"string",
       “Address5”:”String Content”,
       "Address5":"string",
       “Address6”:”String Content”,
       "Address6":"string",
       “Address7”:”String Content”,
       "Address7":"string",
       “Address8”:”String Content”,
       "Address8":"string",
       “Address9”:””,
       "Address9":"string",
       “Address10”:””,
       "Address10":"string",
       “Address11”:””,
       "Address11":"string",
       “Address12”:””,
       "Address12":"string",
       “DeliveryAddress”:”String Content”,
       "DeliveryAddress":"string",
       “DeliveryAddress1”:”String Content”,
       "DeliveryAddress1":"string",
       “DeliveryAddress2”:””,
       "DeliveryAddress2":"string",
       “DeliveryAddress3”:””,
       "DeliveryAddress3":"string",
       “DeliveryAddress4”:””,
       "DeliveryAddress4":"string",
       “DeliveryAddress5”:””,
       "DeliveryAddress5":"string",
       “DeliveryAddress6”:””,
       "DeliveryAddress6":"string",
       “DeliveryAddress7”:””,
       "DeliveryAddress7":"string",
       “DeliveryAddress8”:””,
       "DeliveryAddress8":"string",
       “DeliveryAddress9”:””,
       "DeliveryAddress9":"string",
       “DeliveryAddress10”:””,
       "DeliveryAddress10":"string",
       “DeliveryAddress11”:””,
       "DeliveryAddress11":"string",
       “DeliveryAddress12”:””,
       "DeliveryAddress12":"string",
       “CountryName”:”String Content”,
       "CountryName":"string",
       “ISO3166_2”:””,
       "ISO3166_2":"string",
       “ISO3166_3”:””,
       "ISO3166_3":"string",
       “ISO3166_N”:””,
       "ISO3166_N":"string",
       “SuperAdministrativeArea”:””,
       "SuperAdministrativeArea":"string",
       “AdministrativeArea”:””,
       "AdministrativeArea":"string",
       “SubAdministrativeArea”:””,
       "SubAdministrativeArea":"string",
       “Locality”:”String Content”,
       "Locality":"string",
       “DependentLocality”:””,
       "DependentLocality":"string",
       “DoubleDependentLocality”:””,
       "DoubleDependentLocality":"string",
       “Thoroughfare”:””,
       "Thoroughfare":"string",
       “DependentThoroughfare”:””,
       "DependentThoroughfare":"string",
       “Building”:””,
       "Building":"string",
       “Premise”:””,
       "Premise":"string",
       “SubBuilding”:””,
       "SubBuilding":"string",
       “PostalCode”:”Alphanumeric Content”,
       "PostalCode":"string",
       “PostalCodePrimary”:”Alphanumeric Content”,
       "PostalCodePrimary":"string",
       “PostalCodeSecondary”:””,
       "PostalCodeSecondary":"string",
       “Organization”:””,
       "Organization":"string",
       “PostBox”:”String Content”,
       "PostBox":"string",
       “Unmatched”:””,
       "Unmatched":"string",
       “GeneralDelivery”:””,
       "GeneralDelivery":"string",
       “DeliveryInstallation”:””,
       "DeliveryInstallation":"string",
       “Route”:””,
       "Route":"string",
       “AdditionalContent”:””,
       "AdditionalContent":"string",
       “CountrySubdivisionCode”:”String Content”
       "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
     }
     }
   }]
   }]
Line 74: Line 79:
<pre>
<pre>
{
{
   “Version”:”String Content”,
   "Version":"string",
   “ResultCode”:”String Content”,
   "ResultCode":"string",
   “ErrorString”:null,
   "ErrorString":"string",
   “Results”:[{
   "Results":[{
     “Address”:{
     "Address":{
       “Address”:null,
       "Address":"string",
       “Address1”:null,
       "Address1":"string",
       “Address2”:null,
       "Address2":"string",
       “Address3”:null,
       "Address3":"string",
       “Address4”:null,
       "Address4":"string",
       “Address5”:null,
       "Address5":"string",
       “Address6”:null,
       "Address6":"string",
       “Address7”:null,
       "Address7":"string",
       “Address8”:null,
       "Address8":"string",
       “Address9”:null,
       "Address9":"string",
       “Address10”:null,
       "Address10":"string",
       “Address11”:null,
       "Address11":"string",
       “Address12”:null,
       "Address12":"string",
       “DeliveryAddress”:null,
       "DeliveryAddress":"string",
       “DeliveryAddress1”:null,
       "DeliveryAddress1":"string",
       “DeliveryAddress2”:null,
       "DeliveryAddress2":"string",
       “DeliveryAddress3”:null,
       "DeliveryAddress3":"string",
       “DeliveryAddress4”:null,
       "DeliveryAddress4":"string",
       “DeliveryAddress5”:null,
       "DeliveryAddress5":"string",
       “DeliveryAddress6”:null,
       "DeliveryAddress6":"string",
       “DeliveryAddress7”:null,
       "DeliveryAddress7":"string",
       “DeliveryAddress8”:null,
       "DeliveryAddress8":"string",
       “DeliveryAddress9”:null,
       "DeliveryAddress9":"string",
       “DeliveryAddress10”:null,
       "DeliveryAddress10":"string",
       “DeliveryAddress11”:null,
       "DeliveryAddress11":"string",
       “DeliveryAddress12”:null,
       "DeliveryAddress12":"string",
       “CountryName”:null,
       "CountryName":"string",
       “ISO3166_2”:null,
       "ISO3166_2":"string",
       “ISO3166_3”:null,
       "ISO3166_3":"string",
       “ISO3166_N”:null,
       "ISO3166_N":"string",
       “SuperAdministrativeArea”:null,
       "SuperAdministrativeArea":"string",
       “AdministrativeArea”:”String Content”,
       "AdministrativeArea":"string",
       “SubAdministrativeArea”:null,
       "SubAdministrativeArea":"string",
       “Locality”:”String Content”,
       "Locality":"string",
       “DependentLocality”:null,
       "DependentLocality":"string",
       “DoubleDependentLocality”:null,
       "DoubleDependentLocality":"string",
       “Thoroughfare”:null,
       "Thoroughfare":"string",
       “DependentThoroughfare”:null,
       "DependentThoroughfare":"string",
       “Building”:null,
       "Building":"string",
       “Premise”:null,
       "Premise":"string",
       “SubBuilding”:null,
       "SubBuilding":"string",
       “PostalCode”:null,
       "PostalCode":"string",
       “PostalCodePrimary”:”AlphaNumeric Content”,
       "PostalCodePrimary":"string",
       “PostalCodeSecondary”:null,
       "PostalCodeSecondary":"string",
       “Organization”:null,
       "Organization":"string",
       “PostBox”:null,
       "PostBox":"string",
       “Unmatched”:null,
       "Unmatched":"string",
       “GeneralDelivery”:null,
       "GeneralDelivery":"string",
       “DeliveryInstallation”:null,
       "DeliveryInstallation":"string",
       “Route”:null,
       "Route":"string",
       “AdditionalContent”:null,
       "AdditionalContent":"string",
       “CountrySubdivisionCode”:”String Content”
       "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
     }
     }
   }]
   }]
Line 140: Line 150:
<pre>
<pre>
{
{
   “Version”:”2.0.01”,
   "Version":"string",
   “ResultCode”:”String Content”,
   "ResultCode":"string",
   “ErrorString”:null,
   "ErrorString":"string",
   “Results”:[{
   "Results":[{
     “Address”:{
     "Address":{
       “Address”:null,
       "Address":"string",
       “Address1”:null,
       "Address1":"string",
       “Address2”:null,
       "Address2":"string",
       “Address3”:null,
       "Address3":"string",
       “Address4”:null,
       "Address4":"string",
       “Address5”:null,
       "Address5":"string",
       “Address6”:null,
       "Address6":"string",
       “Address7”:null,
       "Address7":"string",
       “Address8”:null,
       "Address8":"string",
       “Address9”:null,
       "Address9":"string",
       “Address10”:null,
       "Address10":"string",
       “Address11”:null,
       "Address11":"string",
       “Address12”:null,
       "Address12":"string",
       “DeliveryAddress”:null,
       "DeliveryAddress":"string",
       “DeliveryAddress1”:null,
       "DeliveryAddress1":"string",
       “DeliveryAddress2”:null,
       "DeliveryAddress2":"string",
       “DeliveryAddress3”:null,
       "DeliveryAddress3":"string",
       “DeliveryAddress4”:null,
       "DeliveryAddress4":"string",
       “DeliveryAddress5”:null,
       "DeliveryAddress5":"string",
       “DeliveryAddress6”:null,
       "DeliveryAddress6":"string",
       “DeliveryAddress7”:null,
       "DeliveryAddress7":"string",
       “DeliveryAddress8”:null,
       "DeliveryAddress8":"string",
       “DeliveryAddress9”:null,
       "DeliveryAddress9":"string",
       “DeliveryAddress10”:null,
       "DeliveryAddress10":"string",
       “DeliveryAddress11”:null,
       "DeliveryAddress11":"string",
       “DeliveryAddress12”:null,
       "DeliveryAddress12":"string",
       “CountryName”:null,
       "CountryName":"string",
       “ISO3166_2”:null,
       "ISO3166_2":"string",
       “ISO3166_3”:null,
       "ISO3166_3":"string",
       “ISO3166_N”:null,
       "ISO3166_N":"string",
       “SuperAdministrativeArea”:null,
       "SuperAdministrativeArea":"string",
       “AdministrativeArea”:”String Content”,
       "AdministrativeArea":"string",
       “SubAdministrativeArea”:null,
       "SubAdministrativeArea":"string",
       “Locality”:”String Content”,
       "Locality":"string",
       “DependentLocality”:null,
       "DependentLocality":"string",
       “DoubleDependentLocality”:null,
       "DoubleDependentLocality":"string",
       “Thoroughfare”:null,
       "Thoroughfare":"string",
       “DependentThoroughfare”:null,
       "DependentThoroughfare":"string",
       “Building”:null,
       "Building":"string",
       “Premise”:null,
       "Premise":"string",
       “SubBuilding”:null,
       "SubBuilding":"string",
       “PostalCode”:null,
       "PostalCode":"string",
       “PostalCodePrimary”:”String Content”,
       "PostalCodePrimary":"string",
       “PostalCodeSecondary”:null,
       "PostalCodeSecondary":"string",
       “Organization”:null,
       "Organization":"string",
       “PostBox”:null,
       "PostBox":"string",
       “Unmatched”:null,
       "Unmatched":"string",
       “GeneralDelivery”:null,
       "GeneralDelivery":"string",
       “DeliveryInstallation”:null,
       "DeliveryInstallation":"string",
       “Route”:null,
       "Route":"string",
       “AdditionalContent”:null,
       "AdditionalContent":"string",
       “CountrySubdivisionCode”:”String Content”
       "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
     }
     }
   }]
   }]
Line 206: Line 221:
<pre>
<pre>
{
{
   “Version”:”2.0.01”,
   "Version":"string",
   “ResultCode”:”String Content”,
   "ResultCode":"string",
   “ErrorString”:null,
   "ErrorString":"string",
   “Results”:[{
   "Results":[{
     “Address”:{
     "Address":{
       “Address”:null,
       "Address":"string",
       “Address1”:null,
       "Address1":"string",
       “Address2”:null,
       "Address2":"string",
       “Address3”:null,
       "Address3":"string",
       “Address4”:null,
       "Address4":"string",
       “Address5”:null,
       "Address5":"string",
       “Address6”:null,
       "Address6":"string",
       “Address7”:null,
       "Address7":"string",
       “Address8”:null,
       "Address8":"string",
       “Address9”:null,
       "Address9":"string",
       “Address10”:null,
       "Address10":"string",
       “Address11”:null,
       "Address11":"string",
       “Address12”:null,
       "Address12":"string",
       “DeliveryAddress”:null,
       "DeliveryAddress":"string",
       “DeliveryAddress1”:null,
       "DeliveryAddress1":"string",
       “DeliveryAddress2”:null,
       "DeliveryAddress2":"string",
       “DeliveryAddress3”:null,
       "DeliveryAddress3":"string",
       “DeliveryAddress4”:null,
       "DeliveryAddress4":"string",
       “DeliveryAddress5”:null,
       "DeliveryAddress5":"string",
       “DeliveryAddress6”:null,
       "DeliveryAddress6":"string",
       “DeliveryAddress7”:null,
       "DeliveryAddress7":"string",
       “DeliveryAddress8”:null,
       "DeliveryAddress8":"string",
       “DeliveryAddress9”:null,
       "DeliveryAddress9":"string",
       “DeliveryAddress10”:null,
       "DeliveryAddress10":"string",
       “DeliveryAddress11”:null,
       "DeliveryAddress11":"string",
       “DeliveryAddress12”:null,
       "DeliveryAddress12":"string",
       “CountryName”:null,
       "CountryName":"string",
       “ISO3166_2”:null,
       "ISO3166_2":"string",
       “ISO3166_3”:null,
       "ISO3166_3":"string",
       “ISO3166_N”:null,
       "ISO3166_N":"string",
       “SuperAdministrativeArea”:null,
       "SuperAdministrativeArea":"string",
       “AdministrativeArea”:”String Content”,
       "AdministrativeArea":"string",
       “SubAdministrativeArea”:null,
       "SubAdministrativeArea":"string",
       “Locality”:”String Content”,
       "Locality":"string",
       “DependentLocality”:null,
       "DependentLocality":"string",
       “DoubleDependentLocality”:null,
       "DoubleDependentLocality":"string",
       “Thoroughfare”:”String Content”,
       "Thoroughfare":"string",
       “DependentThoroughfare”:null,
       "DependentThoroughfare":"string",
       “Building”:null,
       "Building":"string",
       “Premise”:null,
       "Premise":"string",
       “SubBuilding”:null,
       "SubBuilding":"string",
       “PostalCode”:null,
       "PostalCode":"string",
       “PostalCodePrimary”:”String Content”,
       "PostalCodePrimary":"string",
       “PostalCodeSecondary”:null,
       "PostalCodeSecondary":"string",
       “Organization”:null,
       "Organization":"string",
       “PostBox”:null,
       "PostBox":"string",
       “Unmatched”:null,
       "Unmatched":"string",
       “GeneralDelivery”:null,
       "GeneralDelivery":"string",
       “DeliveryInstallation”:null,
       "DeliveryInstallation":"string",
       “Route”:null,
       "Route":"string",
       “AdditionalContent”:null,
       "AdditionalContent":"string",
       “CountrySubdivisionCode”:”String Content”
       "CountrySubdivisionCode":"string"
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
     }
     }
   }]
   }]

Latest revision as of 00:04, 15 December 2021

← Global Express Entry

Express Entry Navigation
Introduction
Global Getting Started
Endpoints
ExpressAddress
ExpressCityState
ExpressFreeForm
ExpressPostalCode
ExpressStreet
GlobalExpressAddress
GlobalExpressCountry
GlobalExpressLocalityAdministrativeArea
GlobalExpressFreeForm
  ↳  Filtering Responses
GlobalExpressPostalCode
GlobalExpressThoroughfare
Examples
XML Response
JSON Response
Global XML Response
Global JSON Response
Token Server
Result Codes
Result Code Use
Express Entry Result Codes
Sample Code



GlobalExpressAddress/GlobalExpressFreeForm

{
  "Version":"string",
  "ResultCode":"string",
  "ErrorString":"string",
  "Results":[{
    "Address":{
      "Address":"string",
      "Address1":"string",
      "Address2":"string",
      "Address3":"string",
      "Address4":"string",
      "Address5":"string",
      "Address6":"string",
      "Address7":"string",
      "Address8":"string",
      "Address9":"string",
      "Address10":"string",
      "Address11":"string",
      "Address12":"string",
      "DeliveryAddress":"string",
      "DeliveryAddress1":"string",
      "DeliveryAddress2":"string",
      "DeliveryAddress3":"string",
      "DeliveryAddress4":"string",
      "DeliveryAddress5":"string",
      "DeliveryAddress6":"string",
      "DeliveryAddress7":"string",
      "DeliveryAddress8":"string",
      "DeliveryAddress9":"string",
      "DeliveryAddress10":"string",
      "DeliveryAddress11":"string",
      "DeliveryAddress12":"string",
      "CountryName":"string",
      "ISO3166_2":"string",
      "ISO3166_3":"string",
      "ISO3166_N":"string",
      "SuperAdministrativeArea":"string",
      "AdministrativeArea":"string",
      "SubAdministrativeArea":"string",
      "Locality":"string",
      "DependentLocality":"string",
      "DoubleDependentLocality":"string",
      "Thoroughfare":"string",
      "DependentThoroughfare":"string",
      "Building":"string",
      "Premise":"string",
      "SubBuilding":"string",
      "PostalCode":"string",
      "PostalCodePrimary":"string",
      "PostalCodeSecondary":"string",
      "Organization":"string",
      "PostBox":"string",
      "Unmatched":"string",
      "GeneralDelivery":"string",
      "DeliveryInstallation":"string",
      "Route":"string",
      "AdditionalContent":"string",
      "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
    }
  }]
}


GlobalExpressLocalityAdministrativeArea

{
  "Version":"string",
  "ResultCode":"string",
  "ErrorString":"string",
  "Results":[{
    "Address":{
      "Address":"string",
      "Address1":"string",
      "Address2":"string",
      "Address3":"string",
      "Address4":"string",
      "Address5":"string",
      "Address6":"string",
      "Address7":"string",
      "Address8":"string",
      "Address9":"string",
      "Address10":"string",
      "Address11":"string",
      "Address12":"string",
      "DeliveryAddress":"string",
      "DeliveryAddress1":"string",
      "DeliveryAddress2":"string",
      "DeliveryAddress3":"string",
      "DeliveryAddress4":"string",
      "DeliveryAddress5":"string",
      "DeliveryAddress6":"string",
      "DeliveryAddress7":"string",
      "DeliveryAddress8":"string",
      "DeliveryAddress9":"string",
      "DeliveryAddress10":"string",
      "DeliveryAddress11":"string",
      "DeliveryAddress12":"string",
      "CountryName":"string",
      "ISO3166_2":"string",
      "ISO3166_3":"string",
      "ISO3166_N":"string",
      "SuperAdministrativeArea":"string",
      "AdministrativeArea":"string",
      "SubAdministrativeArea":"string",
      "Locality":"string",
      "DependentLocality":"string",
      "DoubleDependentLocality":"string",
      "Thoroughfare":"string",
      "DependentThoroughfare":"string",
      "Building":"string",
      "Premise":"string",
      "SubBuilding":"string",
      "PostalCode":"string",
      "PostalCodePrimary":"string",
      "PostalCodeSecondary":"string",
      "Organization":"string",
      "PostBox":"string",
      "Unmatched":"string",
      "GeneralDelivery":"string",
      "DeliveryInstallation":"string",
      "Route":"string",
      "AdditionalContent":"string",
      "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
    }
  }]
}


GlobalExpressPostalCode

{
  "Version":"string",
  "ResultCode":"string",
  "ErrorString":"string",
  "Results":[{
    "Address":{
      "Address":"string",
      "Address1":"string",
      "Address2":"string",
      "Address3":"string",
      "Address4":"string",
      "Address5":"string",
      "Address6":"string",
      "Address7":"string",
      "Address8":"string",
      "Address9":"string",
      "Address10":"string",
      "Address11":"string",
      "Address12":"string",
      "DeliveryAddress":"string",
      "DeliveryAddress1":"string",
      "DeliveryAddress2":"string",
      "DeliveryAddress3":"string",
      "DeliveryAddress4":"string",
      "DeliveryAddress5":"string",
      "DeliveryAddress6":"string",
      "DeliveryAddress7":"string",
      "DeliveryAddress8":"string",
      "DeliveryAddress9":"string",
      "DeliveryAddress10":"string",
      "DeliveryAddress11":"string",
      "DeliveryAddress12":"string",
      "CountryName":"string",
      "ISO3166_2":"string",
      "ISO3166_3":"string",
      "ISO3166_N":"string",
      "SuperAdministrativeArea":"string",
      "AdministrativeArea":"string",
      "SubAdministrativeArea":"string",
      "Locality":"string",
      "DependentLocality":"string",
      "DoubleDependentLocality":"string",
      "Thoroughfare":"string",
      "DependentThoroughfare":"string",
      "Building":"string",
      "Premise":"string",
      "SubBuilding":"string",
      "PostalCode":"string",
      "PostalCodePrimary":"string",
      "PostalCodeSecondary":"string",
      "Organization":"string",
      "PostBox":"string",
      "Unmatched":"string",
      "GeneralDelivery":"string",
      "DeliveryInstallation":"string",
      "Route":"string",
      "AdditionalContent":"string",
      "CountrySubdivisionCode":"string",
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
    }
  }]
}


GlobalExpressThoroughfare

{
  "Version":"string",
  "ResultCode":"string",
  "ErrorString":"string",
  "Results":[{
    "Address":{
      "Address":"string",
      "Address1":"string",
      "Address2":"string",
      "Address3":"string",
      "Address4":"string",
      "Address5":"string",
      "Address6":"string",
      "Address7":"string",
      "Address8":"string",
      "Address9":"string",
      "Address10":"string",
      "Address11":"string",
      "Address12":"string",
      "DeliveryAddress":"string",
      "DeliveryAddress1":"string",
      "DeliveryAddress2":"string",
      "DeliveryAddress3":"string",
      "DeliveryAddress4":"string",
      "DeliveryAddress5":"string",
      "DeliveryAddress6":"string",
      "DeliveryAddress7":"string",
      "DeliveryAddress8":"string",
      "DeliveryAddress9":"string",
      "DeliveryAddress10":"string",
      "DeliveryAddress11":"string",
      "DeliveryAddress12":"string",
      "CountryName":"string",
      "ISO3166_2":"string",
      "ISO3166_3":"string",
      "ISO3166_N":"string",
      "SuperAdministrativeArea":"string",
      "AdministrativeArea":"string",
      "SubAdministrativeArea":"string",
      "Locality":"string",
      "DependentLocality":"string",
      "DoubleDependentLocality":"string",
      "Thoroughfare":"string",
      "DependentThoroughfare":"string",
      "Building":"string",
      "Premise":"string",
      "SubBuilding":"string",
      "PostalCode":"string",
      "PostalCodePrimary":"string",
      "PostalCodeSecondary":"string",
      "Organization":"string",
      "PostBox":"string",
      "Unmatched":"string",
      "GeneralDelivery":"string",
      "DeliveryInstallation":"string",
      "Route":"string",
      "AdditionalContent":"string",
      "CountrySubdivisionCode":"string"
      "MAK":"string",
      "BaseMAK":"string",
      "Latitude":"string",
      "Longitude":"string",
      "DistanceFromPoint":"float"
    }
  }]
}