POST api/Address/AddAddress
Request Information
URI Parameters
None.
Body Parameters
AddEditAddressRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Agent | string |
None. |
|
| 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. |
|
| CountryCode | string |
None. |
|
| Country | string |
None. |
|
| City | string |
None. |
|
| Town | string |
None. |
|
| District | string |
None. |
|
| ZipCode | string |
None. |
|
| PhoneNumber | string |
None. |
|
| GsmNumber | 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. |
|
| SetAlsoAsBillingAddress | boolean |
None. |
|
| FullName | string |
None. |
|
| Latitude | decimal number |
None. |
|
| Longitude | decimal number |
None. |
|
| Street | string |
None. |
|
| BuildingNo | string |
None. |
|
| IsEBillResponsible | boolean |
None. |
|
| Premise | string |
None. |
|
| Village | string |
None. |
|
| HasGeolocation | boolean |
None. |
|
| OutsourceType | integer |
None. |
|
| CityCode | string |
None. |
|
| DistrictCode | string |
None. |
|
| TownCode | string |
None. |
|
| BillingAddressName | string |
None. |
|
| BillingFirstName | string |
None. |
|
| BillingLastName | string |
None. |
|
| BillingAddressLine1 | string |
None. |
|
| BillingZipCode | string |
None. |
|
| BillingCountryCode | string |
None. |
|
| BillingCountry | string |
None. |
|
| BillingCity | string |
None. |
|
| BillingTown | string |
None. |
|
| BillingDistrict | string |
None. |
|
| BillingPhoneNumber | string |
None. |
|
| BillingGsmNumber | string |
None. |
|
| BillingCityCode | string |
None. |
|
| BillingDistrictCode | string |
None. |
|
| BillingTownCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Agent": "sample string 1",
"UserId": "dc4af993-4e2e-4c3a-9fd4-84cd6fda4094",
"Id": "24b31d8a-57dc-4fcd-8b88-cc396dd04586",
"AddressType": 4,
"AddressName": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"Description": "sample string 8",
"AddressLine1": "sample string 9",
"AddressLine2": "sample string 10",
"CountryCode": "sample string 11",
"Country": "sample string 12",
"City": "sample string 13",
"Town": "sample string 14",
"District": "sample string 15",
"ZipCode": "sample string 16",
"PhoneNumber": "sample string 17",
"GsmNumber": "sample string 18",
"Locale": 1,
"BillingType": 19,
"CompanyName": "sample string 20",
"TaxOffice": "sample string 21",
"TaxNumber": "sample string 22",
"CitizenId": "sample string 23",
"Nationality": 24,
"IsDefault": true,
"SetAlsoAsBillingAddress": true,
"FullName": "sample string 27",
"Latitude": 1.1,
"Longitude": 1.1,
"Street": "sample string 28",
"BuildingNo": "sample string 29",
"IsEBillResponsible": true,
"Premise": "sample string 30",
"Village": "sample string 31",
"HasGeolocation": true,
"OutsourceType": 33,
"CityCode": "sample string 34",
"DistrictCode": "sample string 35",
"TownCode": "sample string 36",
"BillingAddressName": "sample string 37",
"BillingFirstName": "sample string 38",
"BillingLastName": "sample string 39",
"BillingAddressLine1": "sample string 40",
"BillingZipCode": "sample string 41",
"BillingCountryCode": "sample string 42",
"BillingCountry": "sample string 43",
"BillingCity": "sample string 44",
"BillingTown": "sample string 45",
"BillingDistrict": "sample string 46",
"BillingPhoneNumber": "sample string 47",
"BillingGsmNumber": "sample string 48",
"BillingCityCode": "sample string 49",
"BillingDistrictCode": "sample string 50",
"BillingTownCode": "sample string 51"
}
application/xml, text/xml
Sample:
<AddEditAddressRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Request"> <AddressLine1>sample string 9</AddressLine1> <AddressLine2>sample string 10</AddressLine2> <AddressName>sample string 5</AddressName> <AddressType>4</AddressType> <Agent>sample string 1</Agent> <BillingAddressLine1>sample string 40</BillingAddressLine1> <BillingAddressName>sample string 37</BillingAddressName> <BillingCity>sample string 44</BillingCity> <BillingCityCode>sample string 49</BillingCityCode> <BillingCountry>sample string 43</BillingCountry> <BillingCountryCode>sample string 42</BillingCountryCode> <BillingDistrict>sample string 46</BillingDistrict> <BillingDistrictCode>sample string 50</BillingDistrictCode> <BillingFirstName>sample string 38</BillingFirstName> <BillingGsmNumber>sample string 48</BillingGsmNumber> <BillingLastName>sample string 39</BillingLastName> <BillingPhoneNumber>sample string 47</BillingPhoneNumber> <BillingTown>sample string 45</BillingTown> <BillingTownCode>sample string 51</BillingTownCode> <BillingType>19</BillingType> <BillingZipCode>sample string 41</BillingZipCode> <BuildingNo>sample string 29</BuildingNo> <CitizenId>sample string 23</CitizenId> <City>sample string 13</City> <CityCode>sample string 34</CityCode> <CompanyName>sample string 20</CompanyName> <Country>sample string 12</Country> <CountryCode>sample string 11</CountryCode> <Description>sample string 8</Description> <District>sample string 15</District> <DistrictCode>sample string 35</DistrictCode> <FirstName>sample string 6</FirstName> <FullName>sample string 27</FullName> <GsmNumber>sample string 18</GsmNumber> <HasGeolocation>true</HasGeolocation> <Id>24b31d8a-57dc-4fcd-8b88-cc396dd04586</Id> <IsDefault>true</IsDefault> <IsEBillResponsible>true</IsEBillResponsible> <LastName>sample string 7</LastName> <Latitude>1.1</Latitude> <Locale>1</Locale> <Longitude>1.1</Longitude> <Nationality>24</Nationality> <OutsourceType>33</OutsourceType> <PhoneNumber>sample string 17</PhoneNumber> <Premise>sample string 30</Premise> <SetAlsoAsBillingAddress>true</SetAlsoAsBillingAddress> <Street>sample string 28</Street> <TaxNumber>sample string 22</TaxNumber> <TaxOffice>sample string 21</TaxOffice> <Town>sample string 14</Town> <TownCode>sample string 36</TownCode> <UserId>dc4af993-4e2e-4c3a-9fd4-84cd6fda4094</UserId> <Village>sample string 31</Village> <ZipCode>sample string 16</ZipCode> </AddEditAddressRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AddAddressResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| SetAlsoAsBillingAddressId | globally unique identifier |
None. |
|
| Message | string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "13938227-b52e-4ff3-82d4-1bc3d2e7992c",
"SetAlsoAsBillingAddressId": "5ffe59e1-9bf6-4d55-8497-bc4d847577a9",
"Message": "sample string 3",
"Success": true
}
application/xml, text/xml
Sample:
<AddAddressResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessLayer.Dto.Response"> <Id>13938227-b52e-4ff3-82d4-1bc3d2e7992c</Id> <Message>sample string 3</Message> <SetAlsoAsBillingAddressId>5ffe59e1-9bf6-4d55-8497-bc4d847577a9</SetAlsoAsBillingAddressId> <Success>true</Success> </AddAddressResponse>