POST api/Address/GetAddress
Request Information
URI Parameters
None.
Body Parameters
GetAddressByIdRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| UserId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "58dd3c5f-eae1-42f3-aa7c-fa1e05239cad",
"UserId": "96fce0a9-3946-423a-9c3b-e6d31f63033f"
}
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>58dd3c5f-eae1-42f3-aa7c-fa1e05239cad</Id> <UserId>96fce0a9-3946-423a-9c3b-e6d31f63033f</UserId> </GetAddressByIdRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GetAddressByIdResponse| Name | Description | 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. |
Response Formats
application/json, text/json
Sample:
{
"UserId": "31d9f4fc-c348-4179-854f-2c477fbed263",
"Id": "a434672d-696a-423e-b873-d19502d9a27f",
"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"
}
application/xml, text/xml
Sample:
<GetAddressByIdResponse 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> <CitizenId>sample string 17</CitizenId> <CityName>sample string 23</CityName> <CompanyName>sample string 14</CompanyName> <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> <FirstName>sample string 5</FirstName> <FullName>sample string 28</FullName> <Id>a434672d-696a-423e-b873-d19502d9a27f</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> <UserId>31d9f4fc-c348-4179-854f-2c477fbed263</UserId> <Village>sample string 31</Village> <ZipCode>sample string 10</ZipCode> </GetAddressByIdResponse>