GET api/AccountContacts

Returns a list of all account contacts in your database. This list is searchable using the OData protocol.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of AccountContact

Name	Type	Additional information
AccountContactId	integer	None.
AccountId	integer	None.
ContactId	integer	None.
AccountContactType	AccountContactType	None.
IsPrimary	boolean	None.
IsBilling	boolean	None.
IsEmergency	boolean	None.
IsActive	boolean	None.
CanRegisterSelfOnline	boolean	None.
CanRegisterSelfAndOthersOnline	boolean	None.
CanEditDataOnline	boolean	None.
UnitId	integer	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AccountContactId": 1,
    "AccountId": 2,
    "ContactId": 3,
    "AccountContactType": {
      "AccountContactTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "IsAvailableOnline": true,
      "IsAvailableForAdult": true,
      "IsAvailableForChild": true,
      "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"
        }
      ]
    },
    "IsPrimary": true,
    "IsBilling": true,
    "IsEmergency": true,
    "IsActive": true,
    "CanRegisterSelfOnline": true,
    "CanRegisterSelfAndOthersOnline": true,
    "CanEditDataOnline": true,
    "UnitId": 11,
    "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"
      }
    ]
  },
  {
    "AccountContactId": 1,
    "AccountId": 2,
    "ContactId": 3,
    "AccountContactType": {
      "AccountContactTypeId": 1,
      "OrganizationId": 2,
      "Description": "sample string 3",
      "IsActive": true,
      "IsSystemDefined": true,
      "IsAvailableOnline": true,
      "IsAvailableForAdult": true,
      "IsAvailableForChild": true,
      "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"
        }
      ]
    },
    "IsPrimary": true,
    "IsBilling": true,
    "IsEmergency": true,
    "IsActive": true,
    "CanRegisterSelfOnline": true,
    "CanRegisterSelfAndOthersOnline": true,
    "CanEditDataOnline": true,
    "UnitId": 11,
    "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:

<ArrayOfAccountContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <AccountContact>
    <AccountContactId>1</AccountContactId>
    <AccountContactType>
      <AccountContactTypeId>1</AccountContactTypeId>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsAvailableForAdult>true</IsAvailableForAdult>
      <IsAvailableForChild>true</IsAvailableForChild>
      <IsAvailableOnline>true</IsAvailableOnline>
      <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>
      <OrganizationId>2</OrganizationId>
    </AccountContactType>
    <AccountId>2</AccountId>
    <CanEditDataOnline>true</CanEditDataOnline>
    <CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
    <CanRegisterSelfOnline>true</CanRegisterSelfOnline>
    <ContactId>3</ContactId>
    <IsActive>true</IsActive>
    <IsBilling>true</IsBilling>
    <IsEmergency>true</IsEmergency>
    <IsPrimary>true</IsPrimary>
    <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>
    <UnitId>11</UnitId>
  </AccountContact>
  <AccountContact>
    <AccountContactId>1</AccountContactId>
    <AccountContactType>
      <AccountContactTypeId>1</AccountContactTypeId>
      <Description>sample string 3</Description>
      <IsActive>true</IsActive>
      <IsAvailableForAdult>true</IsAvailableForAdult>
      <IsAvailableForChild>true</IsAvailableForChild>
      <IsAvailableOnline>true</IsAvailableOnline>
      <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>
      <OrganizationId>2</OrganizationId>
    </AccountContactType>
    <AccountId>2</AccountId>
    <CanEditDataOnline>true</CanEditDataOnline>
    <CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
    <CanRegisterSelfOnline>true</CanRegisterSelfOnline>
    <ContactId>3</ContactId>
    <IsActive>true</IsActive>
    <IsBilling>true</IsBilling>
    <IsEmergency>true</IsEmergency>
    <IsPrimary>true</IsPrimary>
    <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>
    <UnitId>11</UnitId>
  </AccountContact>
</ArrayOfAccountContact>