GET api/v{version}/AddressTypes

Gets the codes and names of each available address type in the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns the code and names of each address type.

Collection of AddressType
NameDescriptionTypeAdditional information
Code

Gets or sets the code that can be used to identify the address type.

 string

None.
Name

Gets or sets the friendly name of the address type.

 string

None.

Response Formats

application/json, text/json, application/problem+json

Sample: 
[
  {
    "code": "Home",
    "name": "Home"
  },
  {
    "code": "Emerg",
    "name": "Emergency"
  },
  {
    "code": "Alt",
    "name": "Alternate"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfAddressType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <AddressType>
    <Code>Home</Code>
    <Name>Home</Name>
  </AddressType>
  <AddressType>
    <Code>Emerg</Code>
    <Name>Emergency</Name>
  </AddressType>
  <AddressType>
    <Code>Alt</Code>
    <Name>Alternate</Name>
  </AddressType>
</ArrayOfAddressType>