GET api/settingsaddress

Get address settings defined in Abacus.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/settingsaddress. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of addressfields with its settings information.

Collection of SettingsAddressDto

Name	Description	Type	Additional information
AddressFieldName	Addressfield name.	string
AddressFieldLabel	Addressfield label.	string
DefaultTextValue	Addressfield default text value if it has not a list of values.	string	The value is null if UseList is set to true.
DefaultAddressListValueID	Addressfield default value if it has a list of values.	integer	The value is null if UseList is set to false.
ForCustomer	Indicate that addressfield settings applied to customer address	boolean
UseList	Indicate that addressfield has a list for its values	boolean
AddressListID	Addressfield's value list id	integer	The value is null if UseList is set to false.
Required	Indicate that addressfield is a required field	boolean
ForBranch	Indicate that addressfield settings applied to branch address	boolean
ParentAddressListID	Parent list id of which addressfield's value list is a child	integer	The value is null if UseList is set to false.

Response Formats

application/json, text/json

Sample:

[
  {
    "addressFieldName": "sample string 1",
    "addressFieldLabel": "sample string 2",
    "defaultTextValue": "sample string 3",
    "defaultAddressListValueID": 1,
    "forCustomer": true,
    "useList": true,
    "addressListID": 1,
    "required": true,
    "forBranch": true,
    "parentAddressListID": 1
  },
  {
    "addressFieldName": "sample string 1",
    "addressFieldLabel": "sample string 2",
    "defaultTextValue": "sample string 3",
    "defaultAddressListValueID": 1,
    "forCustomer": true,
    "useList": true,
    "addressListID": 1,
    "required": true,
    "forBranch": true,
    "parentAddressListID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfSettingsAddressDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <SettingsAddressDto>
    <AddressFieldLabel>sample string 2</AddressFieldLabel>
    <AddressFieldName>sample string 1</AddressFieldName>
    <AddressListID>1</AddressListID>
    <DefaultAddressListValueID>1</DefaultAddressListValueID>
    <DefaultTextValue>sample string 3</DefaultTextValue>
    <ForBranch>true</ForBranch>
    <ForCustomer>true</ForCustomer>
    <ParentAddressListID>1</ParentAddressListID>
    <Required>true</Required>
    <UseList>true</UseList>
  </SettingsAddressDto>
  <SettingsAddressDto>
    <AddressFieldLabel>sample string 2</AddressFieldLabel>
    <AddressFieldName>sample string 1</AddressFieldName>
    <AddressListID>1</AddressListID>
    <DefaultAddressListValueID>1</DefaultAddressListValueID>
    <DefaultTextValue>sample string 3</DefaultTextValue>
    <ForBranch>true</ForBranch>
    <ForCustomer>true</ForCustomer>
    <ParentAddressListID>1</ParentAddressListID>
    <Required>true</Required>
    <UseList>true</UseList>
  </SettingsAddressDto>
</ArrayOfSettingsAddressDto>