GET api/AddressTypes

Returns a list of all address types in your database

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of AddressType

Name	Type	Additional information
AddressTypeId	integer	None.
OrganizationId	integer	None.
Description	string	None.
IsActive	boolean	None.
IsSystemDefined	boolean	None.
CreateDate	date	None.
CreateUserId	integer	None.
ModifyDate	date	None.
ModifyUserId	integer	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AddressTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "CreateDate": "2026-04-04T00:28:29.5121863-07:00",
    "CreateUserId": 6,
    "ModifyDate": "2026-04-04T00:28:29.5121863-07:00",
    "ModifyUserId": 7,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "AddressTypeId": 1,
    "OrganizationId": 2,
    "Description": "sample string 3",
    "IsActive": true,
    "IsSystemDefined": true,
    "CreateDate": "2026-04-04T00:28:29.5121863-07:00",
    "CreateUserId": 6,
    "ModifyDate": "2026-04-04T00:28:29.5121863-07:00",
    "ModifyUserId": 7,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfAddressType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <AddressType>
    <AddressTypeId>1</AddressTypeId>
    <CreateDate>2026-04-04T00:28:29.5121863-07:00</CreateDate>
    <CreateUserId>6</CreateUserId>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsSystemDefined>true</IsSystemDefined>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <ModifyDate>2026-04-04T00:28:29.5121863-07:00</ModifyDate>
    <ModifyUserId>7</ModifyUserId>
    <OrganizationId>2</OrganizationId>
  </AddressType>
  <AddressType>
    <AddressTypeId>1</AddressTypeId>
    <CreateDate>2026-04-04T00:28:29.5121863-07:00</CreateDate>
    <CreateUserId>6</CreateUserId>
    <Description>sample string 3</Description>
    <IsActive>true</IsActive>
    <IsSystemDefined>true</IsSystemDefined>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <ModifyDate>2026-04-04T00:28:29.5121863-07:00</ModifyDate>
    <ModifyUserId>7</ModifyUserId>
    <OrganizationId>2</OrganizationId>
  </AddressType>
</ArrayOfAddressType>