GET api/Catalog/ZipCode/{ZipCode}
Obtener Pais, estado y municipio a partir del código postal
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ZipCode |
código postal |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseModelApiOfListOfZipCodeApiModelName | Description | Type | Additional information |
---|---|---|---|
success |
Indica si la solicitud se procesó de manera satisfactoria |
boolean |
None. |
message |
Mensaje de la solicitud |
string |
None. |
messageDetail |
Lista de mensajes |
Collection of string |
None. |
failureCode |
Código de error en caso de existir |
string |
None. |
data |
Layout de respuesta de la solicitud |
Collection of ZipCodeApiModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "success": true, "message": "sample string 2", "messageDetail": [ "sample string 1", "sample string 2" ], "failureCode": "sample string 3", "data": [ { "MuniciplalityId": 1, "MunicipalityName": "sample string 2", "StateId": 3, "StateName": "sample string 4", "CountryId": 5, "CountryName": "sample string 6", "ZipCode": "sample string 7" }, { "MuniciplalityId": 1, "MunicipalityName": "sample string 2", "StateId": 3, "StateName": "sample string 4", "CountryId": 5, "CountryName": "sample string 6", "ZipCode": "sample string 7" } ] }
application/xml, text/xml
Sample:
<ResponseModelApiOfListOfZipCodeApiModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <success>true</success> <message>sample string 2</message> <messageDetail> <string>sample string 1</string> <string>sample string 2</string> </messageDetail> <failureCode>sample string 3</failureCode> <data> <ZipCodeApiModel> <MuniciplalityId>1</MuniciplalityId> <MunicipalityName>sample string 2</MunicipalityName> <StateId>3</StateId> <StateName>sample string 4</StateName> <CountryId>5</CountryId> <CountryName>sample string 6</CountryName> <ZipCode>sample string 7</ZipCode> </ZipCodeApiModel> <ZipCodeApiModel> <MuniciplalityId>1</MuniciplalityId> <MunicipalityName>sample string 2</MunicipalityName> <StateId>3</StateId> <StateName>sample string 4</StateName> <CountryId>5</CountryId> <CountryName>sample string 6</CountryName> <ZipCode>sample string 7</ZipCode> </ZipCodeApiModel> </data> </ResponseModelApiOfListOfZipCodeApiModel>