GET api/settingsaddress/listvalues/{addresslistid}

Get addressfield list values 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/listvalues/{addresslistid}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
addresslistid	AddressListId of address list.	integer	Required

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 values of addressfield list.

Collection of AddressListValueDto

Name	Description	Type
Id	A list value id.	integer
Name	A list value name.	string
AddressListId	An id of the list to which this value belongs to.	integer
ParentAddressListValueId	A parent value id of this list value.	integer
CuAccountPortfolioId	unique identifier of an account portfolio that's linked with addresslistvalue.	integer

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 1",
    "addressListId": 1,
    "parentAddressListValueId": 1,
    "cuAccountPortfolioId": 1
  },
  {
    "id": 1,
    "name": "sample string 1",
    "addressListId": 1,
    "parentAddressListValueId": 1,
    "cuAccountPortfolioId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddressListValueDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AddressListValueDto>
    <AddressListId>1</AddressListId>
    <CuAccountPortfolioId>1</CuAccountPortfolioId>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <ParentAddressListValueId>1</ParentAddressListValueId>
  </AddressListValueDto>
  <AddressListValueDto>
    <AddressListId>1</AddressListId>
    <CuAccountPortfolioId>1</CuAccountPortfolioId>
    <Id>1</Id>
    <Name>sample string 1</Name>
    <ParentAddressListValueId>1</ParentAddressListValueId>
  </AddressListValueDto>
</ArrayOfAddressListValueDto>