GET Clients/CommunicationMethod/Initialize?EntityID={EntityID}&BUID={BUID}&Type={Type}
Get empty clientCommunicationMethod
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EntityID | integer |
None. |
|
BUID | integer |
None. |
|
Type | CommunicationMethodType |
None. |
Body Parameters
None.
Response Information
Resource Description
Empty CommunicationMethodDTO
CommunicationMethodDTOName | Description | Type | Additional information |
---|---|---|---|
CommunicationMethodID |
The unique identifier for the Communication Method record. This field is readonly. |
integer |
None. |
EntityID |
The unique identifier for the Entity this Communication Method record belongs to. |
integer |
None. |
Type |
The type of communication method. See for available types: Phone or Email. |
CommunicationMethodType |
None. |
CommunicationMethodTypeEntryID |
The **ID** of the Code Table Entry that represents a specific instance of the Communication Method Type. - For a Type of 'Phone', this will refer to the contents of the built-in Code Table 'Phone Types' (e.g. Home, Work, Mobile). - For a Type of 'Email', this will refer to the contents of the built-in Code Table 'Email Types'. |
integer |
None. |
CommunicationMethodTypeEntryValue |
The **Value** of the Code Table Entry that represents a specific instance of the Communication Method Type. - For a Type of 'Phone', this will refer to the contents of the built-in Code Table 'Phone Types' (e.g. Home, Work, Mobile). - For a Type of 'Email', this will refer to the contents of the built-in Code Table 'Email Types'. |
string |
None. |
IsPrimary |
Whether this communication method is the primary method of contact. |
boolean |
None. |
StartDateUtc |
The date and time this Communication Method record became a valid way to contact this Entity. |
date |
None. |
StopDateUtc |
The date and time this Communication Method record stopped being a valid way to contact this Entity. |
date |
None. |
Value |
The Communication Method value, such as a phone number or email address. |
string |
None. |
SubValue |
The Communication Method sub-value, such as an extension for a phone number. |
string |
None. |
SortOrder |
Sort order of the Communication Method record. Is applied per-entity, on the Entity's page listing out contact details. |
integer |
None. |
PartialData |
The value of the PartialData used as the criteria when requesting the Communication Method record. |
PartialDataType |
None. |
RecordState |
The Record State of the Communication Method 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. |
Summary |
A user-friendly text summary of the Communication Method record. This field is read-only. |
string |
None. |