This chapter describes Contact Point APIs. The provided information includes: PL/SQL record structure and procedure, Java inner class and method, and parameter descriptions and validations.
This chapter covers the following topics:
PL/SQL Package Name: HZ_CONTACT_POINT_V2PUB
Java Class Name: HzContactPointV2Pub
PL/SQL Constant:
G_MISS_CONTENT_SOURCE_TYPE (CONSTANT VARCHAR2(30) := 'USER_ENTERED';
TYPE contact_point_rec_type IS RECORD ( contact_point_id NUMBER, contact_point_type VARCHAR2(30), status VARCHAR2(30), owner_table_name VARCHAR2(30), owner_table_id NUMBER, primary_flag VARCHAR2(1), orig_system_reference VARCHAR2(240), orig_system VARCHAR2(30), content_source_type VARCHAR2(30):= G_MISS_CONTENT_SOURCE_TYPE, attribute_category VARCHAR2(30), attribute1 VARCHAR2(150), attribute2 VARCHAR2(150), attribute3 VARCHAR2(150), attribute4 VARCHAR2(150), attribute5 VARCHAR2(150), attribute6 VARCHAR2(150), attribute7 VARCHAR2(150), attribute8 VARCHAR2(150), attribute9 VARCHAR2(150), attribute10 VARCHAR2(150), attribute11 VARCHAR2(150), attribute12 VARCHAR2(150), attribute13 VARCHAR2(150), attribute14 VARCHAR2(150), attribute15 VARCHAR2(150), attribute16 VARCHAR2(150), attribute17 VARCHAR2(150), attribute18 VARCHAR2(150), attribute19 VARCHAR2(150), attribute20 VARCHAR2(150), contact_point_purpose VARCHAR2(30), primary_by_purpose VARCHAR2(1), created_by_module VARCHAR2(150), application_id NUMBER actual_content_source VARCHAR2(30) )
TYPE edi_rec_type IS RECORD( edi_transaction_handlin VARCHAR2(25), edi_id_number VARCHAR2(30), edi_payment_method VARCHAR2(30), edi_payment_format VARCHAR2(30), edi_remittance_method VARCHAR2(30), edi_remittance_instruction VARCHAR2(30), edi_tp_header_id NUMBER, edi_ece_tp_location_code VARCHAR2(40) )
TYPE email_rec_type IS RECORD ( email_format VARCHAR2(30), email_address VARCHAR2(2000) )
TYPE phone_rec_type IS RECORD ( phone_calling_calendar VARCHAR2(30), last_contact_dt_time DATE, timezone_id NUMBER, phone_area_code VARCHAR2(10), phone_country_code VARCHAR2(10), phone_number VARCHAR2(40), phone_extension VARCHAR2(20), phone_line_type VARCHAR2(30), raw_phone_numberVARCHAR2(60) )
TYPE telex_rec_type IS RECORD ( telex_number VARCHAR2(50) )
TYPE web_rec_type IS RECORD ( web_type VARCHAR2(60), url VARCHAR2(2000) )
TYPE eft_rec_type IS RECORD ( eft_transmission_program_id NUMBER, eft_printing_program_id NUMBER, eft_user_number VARCHAR2(30), eft_swift_code VARCHAR2(30), )
public static class ContactPointRec { public BigDecimal contact_point_id; public String contact_point_type; public String status; public String owner_table_name; public BigDecimal owner_table_id; public String primary_flag; public String orig_system_reference; public String orig_system; public String content_source_type; public String attribute_category; public String attribute1; public String attribute2; public String attribute3; public String attribute4; public String attribute5; public String attribute6; public String attribute7; public String attribute8; public String attribute9; public String attribute10; public String attribute11; public String attribute12; public String attribute13; public String attribute14; public String attribute15; public String attribute16; public String attribute17; public String attribute18; public String attribute19; public String attribute20; public String contact_point_purpose; public String primary_by_purpose; public String created_by_module; public BigDecimal application_id; public String actual_content_source; public ContactPointRec(); public ContactPointRec(boolean__RosettaUseGMISSValues); }
public static class EdiRec { public String edi_transaction_handling; public String edi_id_number; public String edi_payment_method; public String edi_payment_format; public String edi_remittance_method; public String edi_remittance_instruction; public BigDecimal edi_tp_header_id; public String edi_ece_tp_location_code;
public EdiRec(); public EdiRec(boolean__RosettaUseGMISSValues); }
public static class EmailRec { public String email_format; public String email_address; public EmailRec(); public EmailRec(boolean __RosettaUseGMISSValues); }
public static class PhoneRec { public String phone_calling_calendar; public java.sql.Timestamp last_contact_dt_time; public BigDecimal timezone_id; public String phone_area_code; public String phone_country_code; public String phone_number; public String phone_extension; public String phone_line_type; public String raw_phone_number;
public PhoneRec(); public PhoneRec(boolean __RosettaUseGMISSValues); }
public static class TelexRec { public String telex_number;
public TelexRec(); public TelexRec(boolean __RosettaUseGMISSValues); }
public static class WebRec { public String web_type; public String url; public WebRec(); public WebRec(boolean __RosettaUseGMISSValues); }
public static class EftRec { public BigDecimal eft_transmission_program_id; public BigDecimal eft_printing_program_id; public String eft_user_number public String eft_swift_code public EftRec() {this(true);} public EftRec(boolean __RosettaUseGMISSValues); }
Use this routine to create a Contact Point for a Party or a Party Site. The supported types of contact points are PHONE, PAGER, EMAIL, TELEX, WEB, EFT, and EDI. This routine creates a record in the HZ_CONTACT_POINTS table. Each contact point type has a corresponding API. You must call the relevant interface and pass the corresponding record, which depends on the type of contact point you create.
You should use the contact type-dependent APIs. A generic API, called Create Contact Point, is available but does not handle EFT contact points or any future contact point types. The generic Create Contact Point API requires that you pass the appropriate record along with the proper contact point type for the contact point that you create.
If orig_system is passed in, the API also creates a record in the HZ_ORIG_SYS_REFERENCES table to store the mapping between the source system reference and the TCA primary key. If timezone_id is not passed in, the API generates a time zone value based on the phone components and time zone setup. However, if the user passes in the time zone the API keeps the time zone value that the user chose.
PROCEDURE create_edi_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_edi_rec IN EDI_REC_TYPE:=G_MISS_EDI_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_email_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_email_rec IN EMAIL REC_TYPE:=G_MISS_EMAIL_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_phone_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_phone_rec IN PHONE REC_TYPE:=G_MISS_PHONE_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_web_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_web_rec IN WEB REC_TYPE:=G_MISS_WEB_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_telex_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_telex_rec IN TELEX REC_TYPE:=G_MISS_TELEX_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_eft_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_eft_rec IN EFT REC_TYPE:=G_MISS_EFT_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE create_contact_point ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_edi_rec IN EDI_REC_TYPE:= G_MISS_EDI_REC, p_email_rec IN EMAIL_REC_TYPE:= G_MISS_EMAIL_REC, p_phone_rec IN PHONE_REC_TYPE:= G_MISS_PHONE_REC, p_telex_rec IN TELEX_REC_TYPE:= G_MISS_TELEX_REC, p_web_rec IN WEB_REC_TYPE:= G_MISS_WEB_REC, x_contact_point_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void createEdiContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EdiRec p_edi_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createEmailContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EmailRec p_email_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createPhoneContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, PhoneRec p_phone_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createWebContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, WebRec p_web_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createTelexContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, TelexRec p_telex_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createEftContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EftRec p_eft_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void createContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EdiRec p_edi_rec, EmailRec p_email_rec, PhoneRec p_phone_rec, TelexRec p_telex_rec, WebRec p_web_rec, BigDecimal [ ] x_contact_point_id, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following tables list information about the parameters in the Create Contact Point API. The tables include the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
contact_point_id | IN | NUMBER | No | Validation: Unique if passed in, else generated from sequence |
contact_point_type | IN | VARCHAR2 | Yes | Validation:
|
status | IN | VARCHAR2 | No | Validation: Validated against AR lookup type REGISTRY_STATUS Default: A |
owner_table_name | IN | VARCHAR2 | Yes | Validation:
Comment: If you are creating contact point for a party, pass HZ_PARTIES, if you are creating contact point for a party site, pass HZ_PARTY_SITES |
owner_table_id | IN | NUMBER | Yes | Validation:
|
primary_flag | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO Default: N |
orig_system_reference | IN | VARCHAR2 | No | Default: contact_point_id Validation: If orig_system is passed in, then orig_system_reference is required. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS.orig_system. |
content_source_type | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS.orig_system with sst_flag value of Y. Default: USER_ENTERED Comment: This parameter is no longer used. Use actual_content_source. |
Attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
contact_point_purpose | IN | VARCHAR2 | No | Validation:
|
primary_by_purpose | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
created_by_module | IN | VARCHAR2 | Yes | Validation: Mandatory attribute. Validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Comment: Text to indicate application from which creation of record is initiated. |
actual_content_source | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS.orig_system with sst_flag value of Y. Default: USER_ENTERED |
If you use the generic validation method, validations only apply when contact_point type = EDI.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
edi_transaction_handling | IN | VARCHAR2 | No | |
edi_id_number | IN | VARCHAR2 | No | |
edi_payment_method | IN | VARCHAR2 | No | |
edi_payment_format | IN | VARCHAR2 | No | |
edi_remittance_method | IN | VARCHAR2 | No | |
edi_remittance_instruction | IN | VARCHAR2 | No | |
edi_tp_header_id | IN | NUMBER | No | |
edi_ece_tp_location_code | IN | VARCHAR2 | No |
If you use the generic validation method, validations only apply when contact_point_type=EMAIL.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
email_format | IN | VARCHAR2 | No | Validation: Validated against AR lookup type EMAIL_FORMAT Default: MAILHTML |
email_address | IN | VARCHAR2 | Yes | Validation: Mandatory attribute |
If you use the generic validation method, validations only apply when contact_point_type = PHONE or PAGER.
Parameter | Type | Data Type | Required | Validation, Default Comment |
---|---|---|---|---|
phone_calling_calendar | IN | VARCHAR2 | No | |
last_contact_dt_time | IN | DATE | No | |
timezone_id | IN | NUMBER | No | Validation: Foreign key to hz_timezone.timezone_id |
phone_area_code | IN | VARCHAR2 | No | |
phone_country_code | IN | VARCHAR2 | No | Validation: Foreign key to hz_phone_country_codes.phone_country_code |
phone_number | IN | VARCHAR2 | Yes/No | Validation: Mandatory if raw_phone_number is not passed in. If raw_phone_number is NULL, then you cannot update phone_number to NULL. |
phone_extension | IN | VARCHAR2 | No | |
phone_line_type | IN | VARCHAR2 | Yes | Validation:
|
raw_phone_number | IN | VARCHAR2 | Yes/No | Validation: Mandatory if phone_number is not passed in |
If you use the generic validation method, validations only apply when contact_point_type = TELEX.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
telex_number | IN | VARCHAR2 | Yes | Validation: Mandatory attribute |
If you use the generic validation method, validations only apply when contact_point_type = WEB.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
web_type | IN | VARCHAR2 | Yes | Validation: Mandatory attribute |
url | IN | VARCHAR2 | Yes | Validation: Mandatory attribute |
If you use the generic validation method, validations only apply when contact_point_type = EFT.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
eft_transmission_program_id | IN | NUMBER | No | |
eft_printing_program_id | IN | NUMBER | No | |
eft_user_number | IN | VARCHAR2 | No | |
eft_swift_code | IN | VARCHAR2 | No | |
x_contact_point_id | OUT | NUMBER | No | Comment: Return contact_point_id of the contact point record created |
The Primary_flag is a lookup code of lookup type YES/NO. The API automatically marks the first active contact point per type for an entity to primary. When the user selects another contact point of same type to be primary, the previous primary contact point will be unset. Also, if the user inactivates the primary contact point, this primary contact point will be unset and next available active contact point with same type will become primary; and if the user activates a contact point, and if this contact point becomes the first active contact point of this type for this entity, the contact point will be marked as primary. Primary flag is defaulted to ‘N' if none of the above scenarios occur and the user does not pass any value for primary flag.
An inactive contact can never be marked as primary.
Only the primary URL, email, phone contact point id, phone purpose, phone line type, phone country code, phone area code, phone number, and phone extension for given parties are denormalized to HZ_PARTIES table.
primary_by_purpose is a lookup code of lookup type YES/NO. It is defaulted to ‘N' if user does not pass a value. There is only one primary per purpose contact point exist for the combination of owner_table_name, owner_table_id, contact_point_type, and contact_point_purpose. If primary_by_purpose is set to 'Y', we need to unset the previous primary per purpose contact point to non-primary. Because setting primary_by_purpose is only making sense when contact_point_purpose has some value, we ignore the primary_by_purpose (setting it to 'N') if contact_point_purpose is null.
Use this routine to update a Contact Point for a Party or a Party Site. the various types of contact points supported are PHONE, PAGER, EMAIL, TELEX, WEB, EFT, and EDI. The API updates a record in the HZ_CONTACT_POINTS table. Each contact point type has a corresponding API. You must call the relevant interface and pass the corresponding record, which depends on the type of contact point you create.
You should use the contact type-dependent APIs. A generic API, called Update Contact Point, is available, but it does not handle EFT contact points or any future contact point types. The generic Update Contact Point API requires that you pass the appropriate record along with the proper contact point type for the contact point that you create.
If the primary key is not passed in, get the primary key from the HZ_ORIG_SYS_REFERENCES table based on orig_system and orig_system_reference if they are not null and unique. If timezone_id is not passed in, the API generates a time zone value based on the changes of the phone components and time zone setup even if a time zone already exists in the database. However, if the user passes in the time zone, the API keeps the time zone value that the user chose.
PROCEDURE update_edi_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_edi_rec IN EDI_REC_TYPE:=G_MISS_EDI_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE update_email_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_email_rec IN EMAIL REC_TYPE:=G_MISS_EMAIL_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2
PROCEDURE update_phone_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_phone_rec IN PHONE REC_TYPE:=G_MISS_PHONE_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE update_web_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_web_rec IN WEB REC_TYPE:=G_MISS_WEB_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE update_telex_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_telex_rec IN TELEX REC_TYPE:=G_MISS_TELEX_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE update_eft_contact_point( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_eft_rec IN EFT REC_TYPE:=G_MISS_EFT_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
PROCEDURE update_contact_point ( p_init_msg_list IN VARCHAR2:= FND_API.G_FALSE, p_contact_point_rec IN CONTACT_POINT_REC_TYPE, p_edi_rec IN EDI_REC_TYPE:= G_MISS_EDI_REC, p_email_rec IN EMAIL_REC_TYPE:= G_MISS_EMAIL_REC, p_phone_rec IN PHONE_REC_TYPE:= G_MISS_PHONE_REC, p_telex_rec IN TELEX_REC_TYPE:= G_MISS_TELEX_REC, p_web_rec IN WEB_REC_TYPE:= G_MISS_WEB_REC, p_object_version_number IN OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 )
public static void updateEdiContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EdiRec p_edi_rec, BigDecimal [] p_object_version_number, String [] x_return_status, BigDecimal [] x_msg_count, String [] x_msg_data ) throws SQLException;
public static void updateEmailContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EmailRec p_email_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void updatePhoneContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, PhoneRec p_phone_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void updateWebContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, WebRec p_web_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void updateTelexContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, TelexRec p_telex_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void updateEftContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EftRec p_eft_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
public static void updateContactPoint( OracleConnection_connection, String p_init_msg_list, ContactPointRec p_contact_point_rec, EdiRec p_edi_rec, EmailRec p_email_rec, PhoneRec p_phone_rec, TelexRec p_telex_rec, WebRec p_web_rec, BigDecimal [ ] p_object_version_number, String [ ] x_return_status, BigDecimal [ ] x_msg_count, String [ ] x_msg_data ) throws SQLException;
The following tables list information about the parameters in the Update Contact Point API. The tables include the parameter names, the type of each parameter, the data type of each parameter, the necessity of the parameter, and other information about the parameter such as validation, defaults, and other comments.
Parameter Name | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
contact_point_id | IN | NUMBER | Yes | Validation: Valid contact_point_id should be passed in Comment: Pass the contact_point_id from hz_contact_points table |
contact_point_type | IN | VARCHAR2 | No | Validation: Not updateable |
status | IN | VARCHAR2 | No | Validation:
|
owner_table_name | IN | VARCHAR2 | No | Validation: Not updateable |
owner_table_id | IN | NUMBER | No | Validation: Not updateable |
primary_flag | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
orig_system_reference | IN | VARCHAR2 | No | Validation: Non updateable, but if a primary key is not passed in, you can pass in any ORIG_SYSTEM and ORIG_SYSTEM_REFERENCE that exists in the HZ_ORIG_SYS_REFERENCE table and unique validation is bypassed. The ORIG_SYSTEM_REFERENCE does not change, but persists in the table. |
orig_system | IN | VARCHAR2 | No | Validation: Foreign key to HZ_ORIG_SYSTEMS.orig_system. |
content_source_type | IN | VARCHAR2 | No | Comment: This parameter is no longer used. Use actual_content_source. Validation: Not updateable |
attribute_category | IN | VARCHAR2 | No | |
attribute1 | IN | VARCHAR2 | No | |
attribute2 | IN | VARCHAR2 | No | |
attribute3 | IN | VARCHAR2 | No | |
attribute4 | IN | VARCHAR2 | No | |
attribute5 | IN | VARCHAR2 | No | |
attribute6 | IN | VARCHAR2 | No | |
attribute7 | IN | VARCHAR2 | No | |
attribute8 | IN | VARCHAR2 | No | |
attribute9 | IN | VARCHAR2 | No | |
attribute10 | IN | VARCHAR2 | No | |
attribute11 | IN | VARCHAR2 | No | |
attribute12 | IN | VARCHAR2 | No | |
attribute13 | IN | VARCHAR2 | No | |
attribute14 | IN | VARCHAR2 | No | |
attribute15 | IN | VARCHAR2 | No | |
attribute16 | IN | VARCHAR2 | No | |
attribute17 | IN | VARCHAR2 | No | |
attribute18 | IN | VARCHAR2 | No | |
attribute19 | IN | VARCHAR2 | No | |
attribute20 | IN | VARCHAR2 | No | |
contact_point_purpose | IN | VARCHAR2 | No | Validation:
|
primary_by_purpose | IN | VARCHAR2 | No | Validation: Validated against AR lookup type YES/NO |
created_by_module | IN | VARCHAR2 | No | Validation: Non updateable if value exists, else validated against AR lookup type HZ_CREATED_BY_MODULE. |
application_id | IN | NUMBER | No | Validation: Not updateable if value exists |
actual_content_source | IN | VARCHAR2 | No | Validation : Cannot be updated. |
If you use the generic validation method, validations only apply when contact_point_type = EDI.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
edi_transaction_handling | IN | VARCHAR2 | No | |
edi_id_number | IN | VARCHAR2 | No | |
edi_payment_method | IN | VARCHAR2 | No | |
edi_payment_format | IN | VARCHAR2 | No | |
edi_remittance_method | IN | VARCHAR2 | No | |
edi_remittance_instruction | IN | VARCHAR2 | No | |
edi_tp_header_id | IN | NUMBER | No | |
edi_ece_tp_location_code | IN | VARCHAR2 | No |
If you use the generic validation method, validations only apply when contact_point_type = EMAIL.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
email_format | IN | VARCHAR2 | No | Validation:
|
email_address | IN | VARCHAR2 | No | Validation: Cannot be set to null during update |
If you use the generic validation method, validations only apply when contact_point_type = PHONE or PAGER.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
phone_calling_calendar | IN | VARCHAR2 | No | |
last_contact_dt_time | IN | DATE | No | |
timezone_id | IN | NUMBER | No | Validation: Foreign key to hz_timezone.timezone_id |
phone_area_code | IN | VARCHAR2 | No | |
phone_country_code | IN | VARCHAR2 | No | Validation: Foreign key to hz_phone_country_codes.phone_country_code |
phone_number | IN | VARCHAR2 | No | Validation: Mandatory if raw_phone_number is not passed in |
phone_extension | IN | VARCHAR2 | No | |
phone_line_type | IN | VARCHAR2 | No | Validation:
|
raw_phone_number | IN | VARCHAR2 | No | Validation: Mandatory if phone_number is not passed in |
If you use generic validations, validations only apply when contact_point_type = TELEX.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
telex_number | IN | VARCHAR2 | No | Validation: Mandatory attribute |
If you use the generic validation method, validations only apply when contact_point_type = WEB.
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
web_type | IN | VARCHAR2 | No | Validation: Cannot be set to null during update |
url | IN | VARCHAR2 | No | Validation: Cannot be set to null during update |
Parameter | Type | Data Type | Required | Validation, Default, Comment |
---|---|---|---|---|
eft_transmission_program_id | IN | NUMBER | No | |
eft_printing_program_id | IN | NUMBER | No | |
eft_user_number | IN | VARCHAR2 | No | |
eft_swift_code | IN | VARCHAR2 | No | |
p_object_version_number | IN OUT |
NUMBER | Yes | Validation:
Comment:
|
The Primary_flag is a lookup code of lookup type YES/NO. The API automatically marks the first activecontact point per type for an entity to primary. When the user selects another contact point of same type to be primary, the previous primary contact point will be unset. Also, if the user inactivates the primary contact point, this primary contact point will be unset and next available active contact point with same type will become primary; and if the user activates a contact point, and if this contact point becomes the first active contact point of this type for this entity, the contact point will be marked as primary. Primary flag is defaulted to N if none of the above scenarios occur and the user does not pass any value for primary flag.
An inactive contact can never be marked as primary
Only the primary URL, email, phone contact point id, phone purpose, phone line type, phone country code, phone area code, phone number, and phone extension for given parties are denormalized to HZ_PARTIES table.
primary_by_purpose is a lookup code of lookup type YES/NO. It is defaulted to ‘N' if user does not pass a value. There is only one primary per purpose contact point exist for the combination of owner_table_name, owner_table_id, contact_point_type, and contact_point_purpose. If primary_by_purpose is set to 'Y', we need to unset the previous primary per purpose contact point to non-primary. Because setting primary_by_purpose is only making sense when contact_point_purpose has some value, we ignore the primary_by_purpose (setting it to 'N') if contact_point_purpose is null.