GET Contacts/BusinessUnit

Get contactBusinessUnits from criteria

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IncludeActive

Include records where RecordState == RecordState.Active

boolean

None.

IncludeInactive

Include records where RecordState == RecordState.Inactive

boolean

None.

IncludeDeleted

Include records where RecordState == RecordState.Deleted

boolean

None.

Match

When searching by string, include records based on match type

MatchCriteriaStringType

None.

EntityIDs

Filter by EntityIDs

Collection of integer

None.

BusinessUnits

Filter by BusinessUnit(s)

Collection of integer

None.

BusinessUnitStatusID

Filter by BusinessUnitStatusID

integer

None.

EntityType

Filter by EntityType

EntityType

None.

Status

Filter by Status

byte

None.

StartDateUtcMin

Filter by StartDateUtcMin

date

None.

StartDateUtcMax

Filter by StartDateUtcMax

date

None.

StopDateUtcMin

Filter by StopDateUtcMin

date

None.

StopDateUtcMax

Filter by StopDateUtcMax

date

None.

StatusReason

Filter by StatusReason

string

None.

StatusReason2

Filter by StatusReason2

string

None.

ReferralSource

Filter by ReferralSource

string

None.

Props

Filter by Props

Collection of Object

None.

RecordState

Filter by RecordState

RecordState

None.

MaxRows

Limit number of rows

integer

None.

CreatedDateUtcMin

Filter by CreatedDateUtcMin

date

None.

CreatedDateUtcMax

Filter by CreatedDateUtcMax

date

None.

LastUpdatedDateUtcMin

Filter by LastUpdatedDateUtcMin

date

None.

LastUpdatedDateUtcMax

Filter by LastUpdatedDateUtcMax

date

None.

Body Parameters

None.

Response Information

Resource Description

List of ContactBusinessUnitDTOs

Collection of ContactBusinessUnitDTO
NameDescriptionTypeAdditional information
ContactID

The unique identifier for the Contact this Contact Business Unit record belongs to.

integer

None.

BUID

The unique identifier for the Business Unit this Contact Business Unit record refers to.

integer

None.

BusinessUnitStatusID

ID of the Business Unit Status of type Contact

integer

None.

StartDateUtc

Start Date for the Contact Business Unit record in UTC,

date

None.

StopDateUtc

Stop Date for the Contact Business Unit record in UTC,

date

None.

StatusReason

An optional string specifying the reason for the client's record in this Business Unit. The allowed values come from the Code table selected in "Reason Code Table" in Business Unit Status setting.

string

None.

StatusReason2

A second optional string specifying the reason for the client's record in this Business Unit The allowed values come from the Code table selected in "Reason 2 Code Table" in Business Unit Status setting.

string

None.

Props

Additional properties for Contact Business Unit record.

Collection of Object

None.

StatusComments

Optional comments regarding the status of Contact Business Unit record.

string

None.

ReferralSource

The source of the referral for the contact's business unit. Input from code table entries where TableName is "Referral Sources", ().

string

None.

RecordState

The Record state of the Contact Business Unit record, .

RecordState

None.

Created

The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly.

AuditDataDTO

None.

LastUpdated

The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly.

AuditDataDTO

None.

BusinessUnitName

Name of the Business Unit this Contact Business Unit record refers to.

string

None.

StatusName

Name of the Business Unit Status of type Contact this Contact Business Unit record refers to.

string

None.

Summary

Summary of the Contact Business Unit record. This field is readonly.

string

None.