POST api/Address/GetAddressById

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Id		globally unique identifier	None.
UserId		globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "3ef3d658-4bd0-49b3-9e83-3c3bb401899e",
  "UserId": "9ebf9c2b-0ee9-4676-b561-97bca7faa7d3"
}

application/xml, text/xml

Sample:

<GetAddressByIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Request">
  <Id>3ef3d658-4bd0-49b3-9e83-3c3bb401899e</Id>
  <UserId>9ebf9c2b-0ee9-4676-b561-97bca7faa7d3</UserId>
</GetAddressByIdRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetAddressByIdWithRegionItemsResponse

Name	Type	Additional information
UserId	globally unique identifier	None.
Id	globally unique identifier	None.
AddressType	integer	None.
AddressName	string	None.
FirstName	string	None.
LastName	string	None.
Description	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
ZipCode	string	None.
PhoneNumber	string	None.
MaskPhoneNumber	string	None.
Locale	integer	None.
BillingType	integer	None.
CompanyName	string	None.
TaxOffice	string	None.
TaxNumber	string	None.
CitizenId	string	None.
Nationality	integer	None.
IsDefault	boolean	None.
CountryCode	string	None.
CountryName	string	None.
CountrySide	string	None.
CityName	string	None.
TownName	string	None.
DistrictName	string	None.
IsEBillTaxPayer	boolean	None.
BuildingNo	string	None.
FullName	string	None.
IsCorporateAddress	boolean	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
Premise	string	None.
Street	string	None.
Village	string	None.
Countries	Collection of CountryItem	None.
Cities	Collection of CityItem	None.
Towns	Collection of TownItem	None.
Districts	Collection of DistrictItem	None.

Response Formats

application/json, text/json

Sample:

{
  "UserId": "aa05d69e-2975-4228-8748-20367b37b313",
  "Id": "315ad653-7ce2-436f-9a51-a932e375ab03",
  "AddressType": 3,
  "AddressName": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Description": "sample string 7",
  "AddressLine1": "sample string 8",
  "AddressLine2": "sample string 9",
  "ZipCode": "sample string 10",
  "PhoneNumber": "sample string 11",
  "MaskPhoneNumber": "sample string 12",
  "Locale": 1,
  "BillingType": 13,
  "CompanyName": "sample string 14",
  "TaxOffice": "sample string 15",
  "TaxNumber": "sample string 16",
  "CitizenId": "sample string 17",
  "Nationality": 18,
  "IsDefault": true,
  "CountryCode": "sample string 20",
  "CountryName": "sample string 21",
  "CountrySide": "sample string 22",
  "CityName": "sample string 23",
  "TownName": "sample string 24",
  "DistrictName": "sample string 25",
  "IsEBillTaxPayer": true,
  "BuildingNo": "sample string 27",
  "FullName": "sample string 28",
  "IsCorporateAddress": true,
  "Latitude": 1.1,
  "Longitude": 1.1,
  "Premise": "sample string 29",
  "Street": "sample string 30",
  "Village": "sample string 31",
  "Countries": [
    {
      "Id": 1,
      "CountryCode": "sample string 2",
      "Name": "sample string 3",
      "IsSelected": true
    },
    {
      "Id": 1,
      "CountryCode": "sample string 2",
      "Name": "sample string 3",
      "IsSelected": true
    }
  ],
  "Cities": [
    {
      "Id": 1,
      "CityCode": "sample string 2",
      "Name": "sample string 3",
      "IsSelected": true
    },
    {
      "Id": 1,
      "CityCode": "sample string 2",
      "Name": "sample string 3",
      "IsSelected": true
    }
  ],
  "Towns": [
    {
      "TownCode": "sample string 1",
      "CityCode": "sample string 2",
      "Name": "sample string 3",
      "Region": 1,
      "IsSelected": true
    },
    {
      "TownCode": "sample string 1",
      "CityCode": "sample string 2",
      "Name": "sample string 3",
      "Region": 1,
      "IsSelected": true
    }
  ],
  "Districts": [
    {
      "DistrictCode": 1,
      "CityCode": 2,
      "TownCode": 3,
      "Name": "sample string 4",
      "IsSelected": true,
      "ZipCode": "sample string 6"
    },
    {
      "DistrictCode": 1,
      "CityCode": 2,
      "TownCode": 3,
      "Name": "sample string 4",
      "IsSelected": true,
      "ZipCode": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<GetAddressByIdWithRegionItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Response">
  <AddressLine1>sample string 8</AddressLine1>
  <AddressLine2>sample string 9</AddressLine2>
  <AddressName>sample string 4</AddressName>
  <AddressType>3</AddressType>
  <BillingType>13</BillingType>
  <BuildingNo>sample string 27</BuildingNo>
  <Cities>
    <GetCityListResponse.CityItem>
      <CityCode>sample string 2</CityCode>
      <Id>1</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
    </GetCityListResponse.CityItem>
    <GetCityListResponse.CityItem>
      <CityCode>sample string 2</CityCode>
      <Id>1</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
    </GetCityListResponse.CityItem>
  </Cities>
  <CitizenId>sample string 17</CitizenId>
  <CityName>sample string 23</CityName>
  <CompanyName>sample string 14</CompanyName>
  <Countries>
    <GetCountryListResponse.CountryItem>
      <CountryCode>sample string 2</CountryCode>
      <Id>1</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
    </GetCountryListResponse.CountryItem>
    <GetCountryListResponse.CountryItem>
      <CountryCode>sample string 2</CountryCode>
      <Id>1</Id>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
    </GetCountryListResponse.CountryItem>
  </Countries>
  <CountryCode>sample string 20</CountryCode>
  <CountryName>sample string 21</CountryName>
  <CountrySide>sample string 22</CountrySide>
  <Description>sample string 7</Description>
  <DistrictName>sample string 25</DistrictName>
  <Districts>
    <GetDistrictListResponse.DistrictItem>
      <CityCode>2</CityCode>
      <DistrictCode>1</DistrictCode>
      <IsSelected>true</IsSelected>
      <Name>sample string 4</Name>
      <TownCode>3</TownCode>
      <ZipCode>sample string 6</ZipCode>
    </GetDistrictListResponse.DistrictItem>
    <GetDistrictListResponse.DistrictItem>
      <CityCode>2</CityCode>
      <DistrictCode>1</DistrictCode>
      <IsSelected>true</IsSelected>
      <Name>sample string 4</Name>
      <TownCode>3</TownCode>
      <ZipCode>sample string 6</ZipCode>
    </GetDistrictListResponse.DistrictItem>
  </Districts>
  <FirstName>sample string 5</FirstName>
  <FullName>sample string 28</FullName>
  <Id>315ad653-7ce2-436f-9a51-a932e375ab03</Id>
  <IsCorporateAddress>true</IsCorporateAddress>
  <IsDefault>true</IsDefault>
  <IsEBillTaxPayer>true</IsEBillTaxPayer>
  <LastName>sample string 6</LastName>
  <Latitude>1.1</Latitude>
  <Locale>1</Locale>
  <Longitude>1.1</Longitude>
  <MaskPhoneNumber>sample string 12</MaskPhoneNumber>
  <Nationality>18</Nationality>
  <PhoneNumber>sample string 11</PhoneNumber>
  <Premise>sample string 29</Premise>
  <Street>sample string 30</Street>
  <TaxNumber>sample string 16</TaxNumber>
  <TaxOffice>sample string 15</TaxOffice>
  <TownName>sample string 24</TownName>
  <Towns>
    <GetTownListResponse.TownItem>
      <CityCode>sample string 2</CityCode>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
      <Region>1</Region>
      <TownCode>sample string 1</TownCode>
    </GetTownListResponse.TownItem>
    <GetTownListResponse.TownItem>
      <CityCode>sample string 2</CityCode>
      <IsSelected>true</IsSelected>
      <Name>sample string 3</Name>
      <Region>1</Region>
      <TownCode>sample string 1</TownCode>
    </GetTownListResponse.TownItem>
  </Towns>
  <UserId>aa05d69e-2975-4228-8748-20367b37b313</UserId>
  <Village>sample string 31</Village>
  <ZipCode>sample string 10</ZipCode>
</GetAddressByIdWithRegionItemsResponse>