GET api/PostalCode/Lookup/{auth}/{PostalCode}/{CountryID}

Use to lookup postal code data

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required
PostalCode	Postal code	string	Required
CountryID	Country identifier	string	Required

Body Parameters

None.

Response Information

Resource Description

PostalCodeResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
Items	List of postal code data	Collection of PostalCodeItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Items": [
    {
      "AirportID": "sample string 1",
      "CountryID": "sample string 2",
      "Latitude": 1,
      "Longitude": 1,
      "PostalCode": "sample string 3",
      "RouteCode": "sample string 4",
      "TimezoneID": "sample string 5"
    },
    {
      "AirportID": "sample string 1",
      "CountryID": "sample string 2",
      "Latitude": 1,
      "Longitude": 1,
      "PostalCode": "sample string 3",
      "RouteCode": "sample string 4",
      "TimezoneID": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<PostalCodeResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Items>
    <PostalCodeItem>
      <AirportID>sample string 1</AirportID>
      <CountryID>sample string 2</CountryID>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <PostalCode>sample string 3</PostalCode>
      <RouteCode>sample string 4</RouteCode>
      <TimezoneID>sample string 5</TimezoneID>
    </PostalCodeItem>
    <PostalCodeItem>
      <AirportID>sample string 1</AirportID>
      <CountryID>sample string 2</CountryID>
      <Latitude>1</Latitude>
      <Longitude>1</Longitude>
      <PostalCode>sample string 3</PostalCode>
      <RouteCode>sample string 4</RouteCode>
      <TimezoneID>sample string 5</TimezoneID>
    </PostalCodeItem>
  </Items>
</PostalCodeResp>