Application Services Interface Reference > Siebel Financial Services ASIs >

Retrieve Household


Retrieve Household allows an application to retrieve household information. Figure 81 describes the structure of this ASI.

Figure 81.  Retrieve Household

Click for full size image

Table 187 lists the integration object and XML tags of this ASI.

Table 187.  Retrieve Household ASI Integration Components
XML Method for SOAP
Integration Object
Integration Object XML Tag
PartyMgmtRetrieveHousehold
CRM Contact Household Interface
ListofCrmContactHouseholdInterface

Table 188 lists all the integration components and the field definitions. The primary integration component's user keys are listed for that component. User keys for other integration components are noted in the field definition.

Table 188.  Retrieve Household ASI Fields
Name
XML Tag
Data Type
Length
Req.
Notes
Contact
Contact
 
 
 
User key fields:
  1. First Name
  2. Last Name
  3. Middle Name
  4. Party UId
Account Id
AccountId
DTYPE_ID
15
 
 
Alias
Alias
DTYPE_TEXT
50
 
 
Assistant
Assistant
DTYPE_TEXT
50
 
 
Assistant Phone #
AssistantPhone
DTYPE_TEXT
40
 
 
Cellular Phone #
CellularPhone
DTYPE_TEXT
40
 
 
Conflict Id
ConflictId
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
Created
Created
DTYPE_DATETIME
7
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
Email Address
ContactEmailAddress1
DTYPE_TEXT
50
 
 
Email Address 2
ContactEmailAddress2
DTYPE_TEXT
50
 
 
Fax Phone #
FaxPhone
DTYPE_TEXT
40
 
 
First Name
FirstName
DTYPE_TEXT
50
Y
User key field for Contact.
Home Phone #
HomePhone
DTYPE_TEXT
40
 
 
Id
Id
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
Integration Id
IntegrationId
DTYPE_TEXT
30
 
 
Job Title
JobTitle
DTYPE_TEXT
75
 
 
Language Code
LanguageCode
DTYPE_TEXT
20
 
 
Language Id
LanguageId
DTYPE_ID
15
 
 
Last Name
LastName
DTYPE_TEXT
50
Y
User key field for Contact.
M/F
MF
DTYPE_TEXT
255
 
Bound by SEX_MF LOV.
M/M
MM
DTYPE_TEXT
15
 
Bound by MR_MS LOV.
Maiden Name
MaidenName
DTYPE_TEXT
50
 
 
Middle Name
MiddleName
DTYPE_TEXT
50
 
User key field for Contact.
Mod Id
ModId
DTYPE_ID
15
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
Party UId
PartyUId
DTYPE_TEXT
30
Y
Pre Default Value: Field: 'Id'.
Person UId
PersonUId
DTYPE_TEXT
100
Y
Pre Default Value: Field: 'Id'.
User key field for Contact.
Personal Contact
PersonalContact
DTYPE_BOOL
1
 
 
Preferred Communication Method
PreferredCommunicationMethod
DTYPE_TEXT
20
 
Bound by COMM_METHOD LOV.
Primary Group/Household Id
PrimaryGroupHouseholdId
DTYPE_ID
15
 
 
Primary Personal Address Id
PrimaryPersonalAddressId
DTYPE_ID
15
 
 
Primary Position Id
PrimaryPositionId
DTYPE_ID
15
 
 
Social Security Number
SocialSecurityNumber
DTYPE_TEXT
20
 
 
Status
Status
DTYPE_TEXT
30
 
Bound by CONTACT_STATUS LOV.
Suppress All Calls
SuppressAllCalls
DTYPE_BOOL
1
 
 
Suppress All Emails
SuppressAllEmails
DTYPE_BOOL
1
 
 
Suppress All Faxes
SuppressAllFaxes
DTYPE_BOOL
1
 
 
Suppress All Mailings
SuppressAllMailings
DTYPE_BOOL
1
 
 
Suppress Share
SuppressShare
DTYPE_BOOL
1
 
 
Time Zone Id
TimeZoneId
DTYPE_ID
15
 
 
Updated
Updated
DTYPE_DATETIME
7
 
This read-only field is automatically populated by the Siebel application on insertion and cannot be updated.
Work Phone #
WorkPhone
DTYPE_TEXT
40
 
 
Work Phone Extension
WorkPhoneExtension
DTYPE_TEXT
10
 
 
Operation
Operation
DTYPE_TEXT
30
 
System field.
Searchspec
Searchspec
DTYPE_TEXT
250
 
System field.
Contact_Household
ContactHousehold
 
 
 
Integration component.
User key field: Household Id.
Household Id
HouseholdId
DTYPE_ID
15
 
User key field for Contact Household.
Household Integration Id
HouseholdIntegrationId
DTYPE_TEXT
100
 
 
Household Number
HouseholdNumber
DTYPE_TEXT
100
 
 
Household Party UId
HouseholdPartyUId
DTYPE_TEXT
30
 
 
Household Status
HouseholdStatus
DTYPE_TEXT
30
 
Bound by HOUSEHOLD_STATUS.
Households
Households
DTYPE_TEXT
50
 
 
IsPrimaryMVG
IsPrimaryMVG
DTYPE_TEXT
1
 
System field.
Operation
Operation
DTYPE_TEXT
30
 
System field.
Searchspec
Searchspec
DTYPE_TEXT
250
 
System field.


 Application Services Interface Reference 
 Published: 15 May 2003