GET api/Contacts

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Contact
NameDescriptionTypeAdditional information
ContactId

integer

None.

LoginId

integer

None.

FirstName

string

Max length: 50

MiddleName

string

Max length: 50

LastName

string

Max length: 50

CompanyName

string

Max length: 255

EmailAddress

string

Max length: 200

Address1

string

Max length: 80

Address2

string

Max length: 80

City

string

Max length: 50

State

string

Max length: 2

ZIP

string

Max length: 10

Phone1

string

Max length: 50

Phone1Type

string

Max length: 10

Phone2

string

Max length: 50

Phone2Type

string

Max length: 10

Status

string

Max length: 20

Permissions

string

Max length: 400

ContactType

string

Max length: 20

ParentEntityId

integer

None.

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

PropertyName

string

None.

AccountNumber

string

None.

UtilityId

integer

None.

AddLogin

boolean

None.

ContactAccounts

Collection of ContactAccount

None.

PropertyId

integer

None.

UnitId

integer

None.

CustomerType

integer

None.

MoveInDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContactId": 1,
    "LoginId": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "CompanyName": "sample string 5",
    "EmailAddress": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "ZIP": "sample string 11",
    "Phone1": "sample string 12",
    "Phone1Type": "sample string 13",
    "Phone2": "sample string 14",
    "Phone2Type": "sample string 15",
    "Status": "sample string 16",
    "Permissions": "sample string 17",
    "ContactType": "sample string 18",
    "ParentEntityId": 1,
    "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
    "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
    "CreatedBy": 1,
    "UpdatedBy": 1,
    "PropertyName": "sample string 19",
    "AccountNumber": "sample string 20",
    "UtilityId": 21,
    "AddLogin": true,
    "ContactAccounts": [
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T21:19:43.6432278+00:00",
        "EndDate": "2020-02-15T21:19:43.6432278+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
        "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      },
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T21:19:43.6432278+00:00",
        "EndDate": "2020-02-15T21:19:43.6432278+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
        "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      }
    ],
    "PropertyId": 23,
    "UnitId": 24,
    "CustomerType": 25,
    "MoveInDate": "2020-02-15T21:19:43.6432278+00:00"
  },
  {
    "ContactId": 1,
    "LoginId": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "CompanyName": "sample string 5",
    "EmailAddress": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "ZIP": "sample string 11",
    "Phone1": "sample string 12",
    "Phone1Type": "sample string 13",
    "Phone2": "sample string 14",
    "Phone2Type": "sample string 15",
    "Status": "sample string 16",
    "Permissions": "sample string 17",
    "ContactType": "sample string 18",
    "ParentEntityId": 1,
    "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
    "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
    "CreatedBy": 1,
    "UpdatedBy": 1,
    "PropertyName": "sample string 19",
    "AccountNumber": "sample string 20",
    "UtilityId": 21,
    "AddLogin": true,
    "ContactAccounts": [
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T21:19:43.6432278+00:00",
        "EndDate": "2020-02-15T21:19:43.6432278+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
        "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      },
      {
        "RecordId": 1,
        "ContactId": 2,
        "AccountId": 3,
        "AccountNum": 4,
        "UtilityId": 5,
        "Status": "sample string 6",
        "UnitId": 7,
        "BeginDate": "2020-02-15T21:19:43.6432278+00:00",
        "EndDate": "2020-02-15T21:19:43.6432278+00:00",
        "FeesOnly": "sample string 8",
        "DateCreated": "2020-02-15T21:19:43.6432278+00:00",
        "DateUpdated": "2020-02-15T21:19:43.6432278+00:00",
        "CreatedBy": 1,
        "UpdatedBy": 1,
        "MoveInPropertyManager": true
      }
    ],
    "PropertyId": 23,
    "UnitId": 24,
    "CustomerType": 25,
    "MoveInDate": "2020-02-15T21:19:43.6432278+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <Contact>
    <AccountNumber>sample string 20</AccountNumber>
    <AddLogin>true</AddLogin>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <City>sample string 9</City>
    <CompanyName>sample string 5</CompanyName>
    <ContactAccounts>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T21:19:43.6432278+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
        <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
        <EndDate>2020-02-15T21:19:43.6432278+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T21:19:43.6432278+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
        <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
        <EndDate>2020-02-15T21:19:43.6432278+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
    </ContactAccounts>
    <ContactId>1</ContactId>
    <ContactType>sample string 18</ContactType>
    <CreatedBy>1</CreatedBy>
    <CustomerType>25</CustomerType>
    <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
    <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
    <EmailAddress>sample string 6</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <LoginId>1</LoginId>
    <MiddleName>sample string 3</MiddleName>
    <MoveInDate>2020-02-15T21:19:43.6432278+00:00</MoveInDate>
    <ParentEntityId>1</ParentEntityId>
    <Permissions>sample string 17</Permissions>
    <Phone1>sample string 12</Phone1>
    <Phone1Type>sample string 13</Phone1Type>
    <Phone2>sample string 14</Phone2>
    <Phone2Type>sample string 15</Phone2Type>
    <PropertyId>23</PropertyId>
    <PropertyName>sample string 19</PropertyName>
    <State>sample string 10</State>
    <Status>sample string 16</Status>
    <UnitId>24</UnitId>
    <UpdatedBy>1</UpdatedBy>
    <UtilityId>21</UtilityId>
    <ZIP>sample string 11</ZIP>
  </Contact>
  <Contact>
    <AccountNumber>sample string 20</AccountNumber>
    <AddLogin>true</AddLogin>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <City>sample string 9</City>
    <CompanyName>sample string 5</CompanyName>
    <ContactAccounts>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T21:19:43.6432278+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
        <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
        <EndDate>2020-02-15T21:19:43.6432278+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
      <ContactAccount>
        <AccountId>3</AccountId>
        <AccountNum>4</AccountNum>
        <BeginDate>2020-02-15T21:19:43.6432278+00:00</BeginDate>
        <ContactId>2</ContactId>
        <CreatedBy>1</CreatedBy>
        <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
        <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
        <EndDate>2020-02-15T21:19:43.6432278+00:00</EndDate>
        <FeesOnly>sample string 8</FeesOnly>
        <MoveInPropertyManager>true</MoveInPropertyManager>
        <RecordId>1</RecordId>
        <Status>sample string 6</Status>
        <UnitId>7</UnitId>
        <UpdatedBy>1</UpdatedBy>
        <UtilityId>5</UtilityId>
      </ContactAccount>
    </ContactAccounts>
    <ContactId>1</ContactId>
    <ContactType>sample string 18</ContactType>
    <CreatedBy>1</CreatedBy>
    <CustomerType>25</CustomerType>
    <DateCreated>2020-02-15T21:19:43.6432278+00:00</DateCreated>
    <DateUpdated>2020-02-15T21:19:43.6432278+00:00</DateUpdated>
    <EmailAddress>sample string 6</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 4</LastName>
    <LoginId>1</LoginId>
    <MiddleName>sample string 3</MiddleName>
    <MoveInDate>2020-02-15T21:19:43.6432278+00:00</MoveInDate>
    <ParentEntityId>1</ParentEntityId>
    <Permissions>sample string 17</Permissions>
    <Phone1>sample string 12</Phone1>
    <Phone1Type>sample string 13</Phone1Type>
    <Phone2>sample string 14</Phone2>
    <Phone2Type>sample string 15</Phone2Type>
    <PropertyId>23</PropertyId>
    <PropertyName>sample string 19</PropertyName>
    <State>sample string 10</State>
    <Status>sample string 16</Status>
    <UnitId>24</UnitId>
    <UpdatedBy>1</UpdatedBy>
    <UtilityId>21</UtilityId>
    <ZIP>sample string 11</ZIP>
  </Contact>
</ArrayOfContact>