Needio.Services

<back to all web services

GetUserAddressEditSettingRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/User/GetAddressEditSetting
GetUserAddressEditSettingRequest Parameters:
NameParameterData TypeRequiredDescription
CategoryKeyquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetUserAddressEditSettingResponse Parameters:
NameParameterData TypeRequiredDescription
UserAddressEditSettingsformUserAddressEditSettingsNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
UserAddressEditSettings Parameters:
NameParameterData TypeRequiredDescription
AttributeDefsformList<SmAttributeDefDTO>No
SmAttributeDefDTO Parameters:
NameParameterData TypeRequiredDescription
ATypeformSmAttributeTypesNo
STypeformSmAttributeSearchTypesNo
AnyTextformstringNo
AllTextformstringNo
CodeformstringNo
ITypeformSmInputTypesNo
AttributeDatasformList<SmAttributeDataDTO>No
DefaultValueformstringNo
MinValueformint?No
MaxValueformint?No
ParentAttributeDefIdformshort?No
SmAttributeInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AttributeDefIdformshortNo
NameformstringNo
LabelTextformstringNo
RequiredformboolNo
SmAttributeTypes Enum:
NameValue
Text1
Number2
Combo11
MultiSelect12
State13
Brand21
SmAttributeSearchTypes Enum:
NameValue
None0
NumberBetween2
SingleSelect11
MultiSelect12
SmInputTypes Enum:
NameValue
Text1
Number2
Tel3
SmAttributeDataDTO Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
CountformintNo
OrderformintNo
GetUserAddressEditSettingResponse Parameters:
NameParameterData TypeRequiredDescription
UserAddressEditSettingsformUserAddressEditSettingsNo

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

HTTP + XML

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

POST /User/GetAddressEditSetting HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetUserAddressEditSettingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <CategoryKey>String</CategoryKey>
</GetUserAddressEditSettingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetUserAddressEditSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <UserAddressEditSettings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:AttributeDefs>
      <d2p1:SmAttributeDefDTO>
        <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
        <d2p1:LabelText>String</d2p1:LabelText>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Required>false</d2p1:Required>
        <d2p1:AType>Text</d2p1:AType>
        <d2p1:AllText>String</d2p1:AllText>
        <d2p1:AnyText>String</d2p1:AnyText>
        <d2p1:AttributeDatas>
          <d2p1:SmAttributeDataDTO>
            <d2p1:Count>0</d2p1:Count>
            <d2p1:Key>String</d2p1:Key>
            <d2p1:Order>0</d2p1:Order>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:SmAttributeDataDTO>
        </d2p1:AttributeDatas>
        <d2p1:Code>String</d2p1:Code>
        <d2p1:DefaultValue>String</d2p1:DefaultValue>
        <d2p1:IType>Text</d2p1:IType>
        <d2p1:MaxValue>0</d2p1:MaxValue>
        <d2p1:MinValue>0</d2p1:MinValue>
        <d2p1:ParentAttributeDefId>0</d2p1:ParentAttributeDefId>
        <d2p1:SType>None</d2p1:SType>
      </d2p1:SmAttributeDefDTO>
    </d2p1:AttributeDefs>
  </UserAddressEditSettings>
</GetUserAddressEditSettingResponse>