API Documentation

  1. Overview
  2. Getting Started
  3. Authentication
    1. Request Expiration
    2. Request Signing
    3. IP Whitelisting
    4. Link Signing
  4. API Reference
    1. Lookup Calls
      1. Lookup Request Time Offset
      2. Lookup All Supported Countries
      3. Lookup Questions By CountryID
      4. Lookup Postal Code Questions By CountryID
    2. Feasibility Calls
      1. Run Feasibility
      2. Run Feasibility by Project
    3. Project Calls
      1. Create Project
      2. Update Project
      3. Delete Project
      4. Duplicate Project
      5. Project Settings - Update
      6. Get Project Settings
      7. Update CPI
      8. Project Multi-Links
      9. Get Project Info
      10. Get Stats By Project
      11. Get Quotas By Project
      12. Get Project List
      13. Update Aggregate Stats by Project
    4. Quota Calls
      1. Create Quota
      2. Update Quota
      3. Delete Quota
    5. Recontact Calls
      1. Recontact by Panelist
      2. Recontact by Transaction
      3. Get Recontact List
      4. Remove Recontact Entries
    6. Project Transaction Calls
      1. Transaction Completion
      2. Transaction Reconciliation
      3. Create Project Transaction
      4. Lookup Transaction Status
      5. Lookup Multiple Transaction Statuses
  5. Test Project URL
  6. Webhooks
    1. Real Time Pricing
  7. Appendix
    1. JSON Examples
    2. Collecting User Data
    3. Real Time Pricing Overview
    4. Project Types
    5. Error Codes
    6. FAQ

4.1.4.Lookup Postal Code Questions By CountryID

Lookup All Supported Countries
Description Fetch the postal code targeting question and supported postal codes for a specific supported country. Currently, postal code targeting is available in US (1), CA (2), UK (3), AU (4), IN (6), DE (7), FR (8), ES (9).
Request URL Prodege Base URL + /lookup-postal-by-country
Request Method GET

 

Request Parameters
Parameter Name Parameter Type Description Required?
apik String Your API Key. Yes
request_date Numeric Timestamp in milliseconds (see Authentication). Yes
signature String The signature of your request (see Authentication). Yes
country_id Numeric The id that uniquely identifies the country (see Lookup All Supported Countries). Yes
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this API call.
postal_question Array JSON string that holds the postal code question details.

 

postal_question Element Model
Property Name Property Type Description
category_name String The category of this question (e.g. Geographic Criteria).
question_id Numeric The id that uniquely identifies this question.
question_name  String  A descriptive name for this question (e.g. Zip US).
question_text   String  The text that is associated with this question (e.g. What is your zip code?).
postal_codes  Array List of supported postal codes associated with this question .
« Lookup Questions By CountryIDFeasibility Calls »
Help Guide Powered by Documentor
Suggest Edit