Postal Codes

Get Postal Code

GET /api/.../postalcodes/{postalcode}

Return a list of postal codes.

Request Information

Parameters
Name Type Required Description
postalcode string Yes Used to return a List of postal code objects.

Response Information

Example
application/json, text/json 
[
    {
        "PostalCodeID":6483,
        "Code":"13212",
        "City":"N SYRACUSE",
        "State":"NY",
        "CountryID":1,
        "Country":null,
        "County":"ONONDAGA"
    },
    {
        "PostalCodeID":6484,
        "Code":"13212",
        "City":"NORTH SYRACUSE",
        "State":"NY",
        "CountryID":1,
        "Country":null,
        "County":"ONONDAGA"
    },
    {
        "PostalCodeID":6485,
        "Code":"13212",
        "City":"SYRACUSE",
        "State":"NY",
        "CountryID":1,
        "Country":null,
        "County":"ONONDAGA"
    }
]

HTTP Response Codes

Code Description
200 OK. Success

Get Postal Codes for a given country

GET /api/.../postalcodes/{postalcode}/{countryid}

Return a list of postal codes for the country.

Request Information

Parameters
Name Type Required Description
postalcode string Yes Used to return a List of postal code objects.
countryid int Yes Used to return a List of postal code objects for the country.

Response Information

Example
application/json, text/json 
[
    {
    "PostalCodeID":874864,
    "Code":"12345",
    "City":"PARIS",
    "State":"NY",
    "CountryID":1,
    "Country":null,
    "County":null},
    {
    "PostalCodeID":5902,
    "Code":"12345",
    "City":"SCHENECTADY",
    "State":"NY",
    "CountryID":1,
    "Country":null,
    "County":"SCHENECTADY"
    },
    {
    "PostalCodeID":874578,
    "Code":"12345",
    "City":"Woldford",
    "State":"NY",
    "CountryID":1,
    "Country":null,
    "County":null
    },
    {
    "PostalCodeID":874598,
    "Code":"12345",
    "City":"Woldford",
    "State":"NY",
    "CountryID":1,
    "Country":null,
    "County":"oneida"
    }
]

HTTP Response Codes

Code Description
200 OK. Success