Needio.Services

<back to all web services

GetUserAddressListRequest

Requires Authentication
The following routes are available for this service:
All Verbs/User/GetUserAddressList/
GetUserAddressListRequest Parameters:
NameParameterData TypeRequiredDescription
IncludeInvoiceAddressesqueryboolNo
IncludeDeliveryAddressesqueryboolNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetUserAddressListResponse Parameters:
NameParameterData TypeRequiredDescription
UserAddressesformList<UserAddressDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
UserAddressDTO Parameters:
NameParameterData TypeRequiredDescription
UserAddressIdformintNo
AddressAliasformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
ZipCodeformstringNo
DistrictIdformint?No
CityIdformint?No
StateIdformint?No
CountryIdformint?No
DistrictformstringNo
StreetformstringNo
BuildingNoformstringNo
DoorNoformstringNo
AddressRecipeformstringNo
GeoAddressformstringNo
LocationformGeoLocationNo
InvoiceYnformboolNo
DeliveryYnformboolNo
ActiveYnformboolNo
DefaultYnformboolNo
PhoneNumberformstringNo
EmailformstringNo
InvoiceAddressTypeformInvoiceAddressTypes?No
InvoiceNameformstringNo
TaxOfficeformstringNo
TaxNoformstringNo
Registerformbool?No
DeliveryNameformstringNo
DeliverySurnameformstringNo
EInvoiceYnformbool?No
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
InvoiceAddressTypes Enum:
NameValue
Personel1
Company2
GetUserAddressListResponse Parameters:
NameParameterData TypeRequiredDescription
UserAddressesformList<UserAddressDTO>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /User/GetUserAddressList/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"IncludeInvoiceAddresses":false,"IncludeDeliveryAddresses":false,"start":"\/Date(1594273957937+0300)\/"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserAddresses":[{"UserAddressId":0,"AddressAlias":"String","Address1":"String","Address2":"String","City":"String","State":"String","Country":"String","ZipCode":"String","DistrictId":0,"CityId":0,"StateId":0,"CountryId":0,"District":"String","Street":"String","BuildingNo":"String","DoorNo":"String","AddressRecipe":"String","GeoAddress":"String","Location":{"Lon":"String","Lat":"String","GeoAddress":"String","IsDeleted":false},"InvoiceYn":false,"DeliveryYn":false,"ActiveYn":false,"DefaultYn":false,"PhoneNumber":"String","Email":"String","InvoiceAddressType":0,"InvoiceName":"String","TaxOffice":"String","TaxNo":"String","Register":false,"DeliveryName":"String","DeliverySurname":"String","EInvoiceYn":false}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"}}