GET api/addressidtype

Get address types.

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/addressidtype. 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 address types.

Collection of AddressIDTypeDto

Name	Description	Type
AddressIDTypeID	Primary key of AddressIDType table.	integer
Name	AddressIDType Name.	string
DefaultItem	Indicates whether it is the default value.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "addressIDTypeID": 1,
    "name": "sample string 1",
    "defaultItem": true
  },
  {
    "addressIDTypeID": 1,
    "name": "sample string 1",
    "defaultItem": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddressIDTypeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <AddressIDTypeDto>
    <AddressIDTypeID>1</AddressIDTypeID>
    <DefaultItem>true</DefaultItem>
    <Name>sample string 1</Name>
  </AddressIDTypeDto>
  <AddressIDTypeDto>
    <AddressIDTypeID>1</AddressIDTypeID>
    <DefaultItem>true</DefaultItem>
    <Name>sample string 1</Name>
  </AddressIDTypeDto>
</ArrayOfAddressIDTypeDto>