POST api/Postal/Search
Request Information
URI Parameters
None.
Body Parameters
PostalSearchParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
PostalCode | string |
None. |
|
CountryID | string |
None. |
|
CityName | string |
None. |
|
AirportID | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "PostalCode": "sample string 2", "CountryID": "sample string 3", "CityName": "sample string 4", "AirportID": "sample string 5" }
application/xml, text/xml
Sample:
<PostalSearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <AirportID>sample string 5</AirportID> <CityName>sample string 4</CityName> <CountryID>sample string 3</CountryID> <PostalCode>sample string 2</PostalCode> <auth>sample string 1</auth> </PostalSearchParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PostalSearchRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | string |
None. |
|
Items | Collection of PostalSearchItem |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2", "Items": [ { "PostalCode": "sample string 1", "CountryID": "sample string 2", "CityName": "sample string 3", "StateProvID": "sample string 4", "TimezoneID": "sample string 5", "AirportID": "sample string 6" }, { "PostalCode": "sample string 1", "CountryID": "sample string 2", "CityName": "sample string 3", "StateProvID": "sample string 4", "TimezoneID": "sample string 5", "AirportID": "sample string 6" } ] }
application/xml, text/xml
Sample:
<PostalSearchResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Items> <PostalSearchItem> <AirportID>sample string 6</AirportID> <CityName>sample string 3</CityName> <CountryID>sample string 2</CountryID> <PostalCode>sample string 1</PostalCode> <StateProvID>sample string 4</StateProvID> <TimezoneID>sample string 5</TimezoneID> </PostalSearchItem> <PostalSearchItem> <AirportID>sample string 6</AirportID> <CityName>sample string 3</CityName> <CountryID>sample string 2</CountryID> <PostalCode>sample string 1</PostalCode> <StateProvID>sample string 4</StateProvID> <TimezoneID>sample string 5</TimezoneID> </PostalSearchItem> </Items> </PostalSearchResp>