GET api/PersonAddress/GetAddressByZipCode?zipCode={zipCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
zipCode

string

Required

Body Parameters

None.

Response Information

Resource Description

AddressDto
NameDescriptionTypeAdditional information
street

string

Required

number

string

Required

complement

string

None.

district

string

Required

zipCode

string

None.

fullAddress

string

None.

coordinates

LocationDto

None.

googleMapsPlaceId

string

None.

cityId

integer

None.

cityName

string

Required

stateAcronym

string

Required

country

string

None.

key

integer

None.

id

integer

None.

isNew

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "street": "sample string 1",
  "number": "sample string 2",
  "complement": "sample string 3",
  "district": "sample string 4",
  "zipCode": "sample string 5",
  "fullAddress": "sample string 1, sample string 2 - sample string 4, sample string 8 - sample string 9, sample string 10, sample string 5",
  "coordinates": {
    "lat": 1.0,
    "lng": 2.0
  },
  "googleMapsPlaceId": "sample string 6",
  "cityId": 7,
  "cityName": "sample string 8",
  "stateAcronym": "sample string 9",
  "country": "sample string 10",
  "key": 11,
  "id": 11,
  "isNew": true
}

application/xml, text/xml

Sample:
<AddressDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OffDriver.Entities.Dto.Location">
  <isNew xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">true</isNew>
  <key xmlns="http://schemas.datacontract.org/2004/07/Zenite.Pi.Web.Models">11</key>
  <cityId>7</cityId>
  <cityName>sample string 8</cityName>
  <complement>sample string 3</complement>
  <coordinates>
    <lat>1</lat>
    <lng>2</lng>
  </coordinates>
  <country>sample string 10</country>
  <district>sample string 4</district>
  <googleMapsPlaceId>sample string 6</googleMapsPlaceId>
  <number>sample string 2</number>
  <stateAcronym>sample string 9</stateAcronym>
  <street>sample string 1</street>
  <zipCode>sample string 5</zipCode>
</AddressDto>