WEBIndividualInsert
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
object |
The WEBIndividualInsert web method inserts a new individual record.
Parameters
The request contains the following parameters:
| Name | Type | Occurs | Description |
|---|---|---|---|
| oFacadeObject | IndividualType | 0($)..1 | The IndividualType to be inserted. |
Response
IndividualType—The newly inserted individual, with additional data set and a new primary key contained in the CurrentKey property.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
[[IndividualType]]
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
The response matches the input fields and includes the customer key and record number if one was not passed into NetForum.
Use Cases
Insert Individual with Organization Name - Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>b9eb6347-342b-4b86-bbc8-76837cded1e5</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_first_name>Francis</ns:ind_first_name>
<ns:ind_last_name>Scott</ns:ind_last_name>
</ns:Individual>
<ns:Customer>
<ns:cst_org_name_dn>FARM Test Org</ns:cst_org_name_dn>
</ns:Customer>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>
Insert Individual with Organization Name - Result
Insert Individual with Related Organization - Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>0e0e12f7-50ac-459d-acba-c333c8fa1cd9</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_first_name>Francis</ns:ind_first_name>
<ns:ind_last_name>Scott</ns:ind_last_name>
</ns:Individual>
<ns:Organization_XRef>
<ns:ixo_rlt_code>Staff</ns:ixo_rlt_code>
<ns:ixo_title>Assistant</ns:ixo_title>
<ns:ixo_org_cst_key>93f99466-93ab-48e7-be72-7d2eb9f69e47</ns:ixo_org_cst_key>
</ns:Organization_XRef>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>
Insert Individual with Related Organization - Result
Insert Individual with Contact Information Using System Defaults - Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>f4496783-4379-4dcc-b399-0a5c80180b5d</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<!--Optional:-->
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_prf_code>Test Prefix</ns:ind_prf_code>
<ns:ind_sfx_code>Test Suffix</ns:ind_sfx_code>
<ns:ind_first_name>Julie</ns:ind_first_name>
<ns:ind_last_name>Test</ns:ind_last_name>
<ns:ind_designation/>
</ns:Individual>
<ns:Customer>
<ns:cst_ixo_title_dn>Staff</ns:cst_ixo_title_dn>
<ns:cst_org_name_dn>Laser Registration</ns:cst_org_name_dn>
<ns:cst_phn_number_complete_dn>2022222222</ns:cst_phn_number_complete_dn>
</ns:Customer>
<ns:Email>
<ns:eml_address>test@avectra.com</ns:eml_address>
</ns:Email>
<ns:Business_Address>
<ns:adr_line1>123 ABC</ns:adr_line1>
<ns:adr_line2/>
<ns:adr_city>Washington</ns:adr_city>
<ns:adr_state>DC</ns:adr_state>
<ns:adr_post_code>20001</ns:adr_post_code>
</ns:Business_Address>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>
Insert Individual with Contact Information Specifying Address and Email Type - Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>f4496783-4379-4dcc-b399-0a5c80180b5d</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<!--Optional:-->
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_prf_code>Test Prefix</ns:ind_prf_code>
<ns:ind_sfx_code>Test Suffix</ns:ind_sfx_code>
<ns:ind_first_name>Julie</ns:ind_first_name>
<ns:ind_last_name>Test</ns:ind_last_name>
<ns:ind_designation/>
</ns:Individual>
<ns:Customer>
<ns:cst_ixo_title_dn>Staff</ns:cst_ixo_title_dn>
<ns:cst_org_name_dn>Laser Registration</ns:cst_org_name_dn>
<ns:cst_phn_number_complete_dn>2022222222</ns:cst_phn_number_complete_dn>
</ns:Customer>
<ns:Email>
<ns:eml_address>test@avectra.com</ns:eml_address>
<ns:eml_type>personal</ns:eml_type>
<ns:eml_primary>1</ns:eml_primary>
</ns:Email>
<ns:Business_Address>
<ns:adr_line1>123 ABC</ns:adr_line1>
<ns:adr_line2/>
<ns:adr_city>Washington</ns:adr_city>
<ns:adr_state>DC</ns:adr_state>
<ns:adr_post_code>20001</ns:adr_post_code>
</ns:Business_Address>
<ns:Business_Address_XRef>
<ns:cxa_adt_key>4B63F9A8-D9A1-4F1D-A5B3-FCCF2DC83ADF</ns:cxa_adt_key>
<ns:cxa_primary>1</ns:cxa_primary>
</ns:Business_Address_XRef>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>
Individual Insert with Linked Address
At this time, it is not possible to insert a linked address with a new individual in xWeb.
JSON Method
Creates a new individual record.
GET n/a
POST /xweb/JSON/WEBIndividualInsert
Copy
DATA: JSON
{
"WEBIndividualInsert": {
"oFacadeObject": {
"CurrentKey": null,
"Individual": {
"ind_prf_code": "Mr.",
"ind_first_name": "JasonTest1",
"ind_mid_name": "D",
"ind_last_name": "WattsTest1",
"ind_sfx_code": null,
"ind_badge_name": "Mr. JasonTest1 WattsTest1",
"ind_department_ext": "IT",
"ind_position_classification_ext": "Other"
},
"Customer": {
"cst_new_password": "Pa$$w0rd",
"cst_new_password_confirm": "Pa$$w0rd",
"cst_ixo_title_dn": "Mr. JasonTest1 WattsTest1",
"cst_phn_number_complete_dn": "8885551212"
},
"Email": {
"eml_address": "jwatts1980+Test1@gmail.com"
},
"Business_Address": {
"adr_line1": "123 Main St.",
"adr_line2": null,
"adr_line3": null,
"adr_city": "Houston",
"adr_state": "TX",
"adr_post_code": "77433",
"adr_country": "UNITED STATES"
},
"Business_Phone": {
"phn_number": "888-555-1212",
"phn_cty_key": null
},
"Business_Phone_XRef": {
"cph_extension": "1234"
},
"Business_Fax": {
"fax_number": null,
"fax_cty_key": null
}
},
"bRefresh": false
}
}
Copy
SAMPLE RESULT: FULL INDIVIDUAL ACCOUNT DETAILS
HTTP STATUS: 200
DATA - JSON
{
"Individual": {
"CurrentKey": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"Individual": {
"ind_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"ind_prf_code": "Mr.",
"ind_first_name": "JasonTest1",
"ind_mid_name": "D",
"ind_last_name": "WattsTest1",
"ind_full_name_cp": "Mr. JasonTest1 D WattsTest1",
"ind_salutation_cp": "Mr. WattsTest1",
"ind_cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"ind_badge_name": "Mr. JasonTest1 WattsTest1",
"ind_deceased_flag": "0",
"ind_add_date": "2020-03-27T00:06:00-05:00",
"ind_add_user": "jwatts",
"ind_delete_flag": "0",
"ind_position_classification_ext": "Other",
"ind_department_ext": "IT",
"ind_cst_main_office_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1"
},
"Customer": {
"cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"cst_type": "Individual",
"cst_name_cp": "Mr. JasonTest1 D WattsTest1",
"cst_sort_name_dn": "WattsTest1 JasonTest1 D",
"cst_ind_full_name_dn": "Mr. JasonTest1 D WattsTest1",
"cst_ixo_title_dn": "Mr. JasonTest1 WattsTest1",
"cst_add_date": "2020-03-27T00:06:00-05:00",
"cst_add_user": "jwatts",
"cst_change_date": "2020-03-27T00:06:00-05:00",
"cst_change_user": "jwatts",
"cst_delete_flag": "0",
"cst_recno": "240656",
"cst_id": "000240656I",
"cst_key_ext": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
"cst_no_email_flag": "0",
"cst_eml_address_dn": "jwatts1980+Test1@gmail.com",
"cst_eml_key": "089afd74-3495-4fce-94a0-72188210299a",
"cst_no_phone_flag": "0",
"cst_phn_number_complete_dn": "8885551212",
"cst_no_fax_flag": "0",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "0",
"cst_web_password": "es9Am3alOaWyFbveOCOtWOxFEfwro1GQ",
"cst_no_mail_flag": "0",
"cst_web_force_password_change": "0",
"cst_web_login_disabled_flag": "0",
"cst_credit_hold_flag": "0",
"cst_web_forgot_password_status": "0",
"cst_no_publish_flag": "0",
"cst_salutation_1": "Mr.. JasonTest1 D WattsTest1 ",
"cst_salutation_2": "",
"cst_default_recognize_as": "Mr.. JasonTest1 D WattsTest1 ",
"cst_score_trend": "0",
"cst_exclude_from_social_flag": "0",
"cst_salt": "ZFDEbjeoTm80mBvwAr1p2Ol4YgFfaEsU",
"cst_iterations": "5000",
"cst_web_password_change_date": "2020-03-27T00:06:00-05:00",
"cst_web_login_locked_flag": "0",
"cst_credit_available": "0.00",
"cst_receives_member_benefits_flag": "0",
"cst__ind_send_mail_reset_flag": "0",
"cst_reset_password_flag": "0"
},
"Organization_XRef": {
"ixo_title": "Mr. JasonTest1 WattsTest1",
"ixo_primary": "1",
"ixo_owner": "1"
},
"Organization": {
"org_consortia_flag": "0"
},
"Email": {
"eml_key": "089afd74-3495-4fce-94a0-72188210299a",
"eml_address": "jwatts1980+Test1@gmail.com",
"eml_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"eml_type": "business",
"eml_add_user": "jwatts",
"eml_add_date": "2020-03-27T00:06:25-05:00",
"eml_delete_flag": "0",
"eml_key_ext": "089afd74-3495-4fce-94a0-72188210299a",
"eml_invalid_flag": "0",
"eml_unlisted_flag": "0",
"eml_primary": "1"
},
"Website": {
"url_type": "internet",
"url_primary": "1"
},
"Messaging": {
"msg_primary": "1"
},
"Business_Address_XRef": {
"cxa_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"cxa_adr_key": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
"cxa_add_date": "2020-03-27T00:06:00-05:00",
"cxa_add_user": "jwatts",
"cxa_change_date": "2020-03-27T00:07:00-05:00",
"cxa_change_user": "jwatts",
"cxa_delete_flag": "0",
"cxa_key": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
"cxa_key_ext": "3fffea6a-7c1c-4ea2-bb0c-6b8d74e4dc06",
"cxa_on_hold_flag": "0",
"cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f",
"cxa_mailing_label": "Mr. JasonTest1 D WattsTest1 Mr. JasonTest1 WattsTest1 123 Main St. Houston, TX 77433",
"cxa_mailing_label_html": "Mr. JasonTest1 D WattsTest1<br>Mr. JasonTest1 WattsTest1<br>123 Main St.<br>Houston, TX 77433",
"cxa_primary": "1",
"cxa_owner": "1",
"cxa_billing": "0",
"cxa_create_change_log": "0"
},
"Business_Address": {
"adr_key": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
"adr_cst_key_owner": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"adr_line1": "123 Main St.",
"adr_city": "Houston",
"adr_state": "TX",
"adr_post_code": "77433",
"adr_city_state_code": "Houston, TX 77433",
"adr_country": "UNITED STATES",
"adr_add_date": "2020-03-27T00:06:27-05:00",
"adr_add_user": "jwatts",
"adr_change_date": "2020-03-27T00:06:31-05:00",
"adr_change_user": "jwatts",
"adr_delete_flag": "0",
"adr_key_ext": "c95a666a-bee2-4dbf-82a2-3ddee254af4d",
"adr_bad_address_flag": "0",
"adr_no_validation_flag": "0"
},
"Business_Address_State": {
"sta_code": "TX",
"sta_cty_code": "UNITED STATES",
"sta_add_user": "admin",
"sta_add_date": "2003-05-12T16:54:00-05:00",
"sta_change_date": "2015-01-06T10:28:00-06:00",
"sta_change_user": "LRiegelman",
"sta_delete_flag": "0",
"sta_key": "85d36bea-54bb-4691-978f-3d4d39f14581",
"sta_key_ext": "85d36bea-54bb-4691-978f-3d4d39f14581",
"sta_name": "Texas",
"sta_type": "state",
"sta_rgn_key": "e69c71a9-3596-4a7d-929b-0ac4fd8e4215",
"sta_bpa_region": "WEST SO. CENTRAL"
},
"Business_Address_Country": {
"cty_code": "UNITED STATES",
"cty_add_date": "2001-12-05T13:44:00-06:00",
"cty_add_user": "XMEN\\tward",
"cty_change_date": "2007-07-11T16:51:42-05:00",
"cty_change_user": "skatragadda",
"cty_delete_flag": "0",
"cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"cty_key_ext": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"cty_long_name": "United States of America",
"cty_fips_code": "US",
"cty_status": "independent",
"cty_capital": "Washington, DC",
"cty_idd_code": "001",
"cty_postal_input_mask": "regex:\\d{5}(-\\d{4})?",
"cty_phone_input_mask": "^(\\d{3})(\\d{3})(\\d{4})$~($1)$2-$3",
"cty_currency_code": "USD",
"cty_currency_code_description": "U.S. Dollar",
"cty_vat_flag": "0",
"cty_iso_2": "US",
"cty_iso_3": "USA",
"cty_do_not_ship": "0",
"cty_iso_number": "840",
"cty_bpa_region": "NORTH AMERICA",
"cty_do_not_sell": "0"
},
"Business_Phone_XRef": {
"cph_pht_key": "88ff5661-2d14-4bdf-be4c-906c3bff7ef7",
"cph_primary": "1",
"cph_owner": "1",
"cph_extension": "1234"
},
"Business_Phone": {
"phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Business_Phone_Country": {
"ct3__cty_code": "UNITED STATES",
"ct3__cty_add_date": "2001-12-05T13:44:00-06:00",
"ct3__cty_add_user": "XMEN\\tward",
"ct3__cty_change_date": "2007-07-11T16:51:42-05:00",
"ct3__cty_change_user": "skatragadda",
"ct3__cty_delete_flag": "0",
"ct3__cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct3__cty_key_ext": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct3__cty_long_name": "United States of America",
"ct3__cty_fips_code": "US",
"ct3__cty_status": "independent",
"ct3__cty_capital": "Washington, DC",
"ct3__cty_idd_code": "001",
"ct3__cty_postal_input_mask": "regex:\\d{5}(-\\d{4})?",
"ct3__cty_phone_input_mask": "^(\\d{3})(\\d{3})(\\d{4})$~($1)$2-$3",
"ct3__cty_currency_code": "USD",
"ct3__cty_currency_code_description": "U.S. Dollar",
"ct3__cty_vat_flag": "0",
"ct3__cty_iso_2": "US",
"ct3__cty_iso_3": "USA",
"ct3__cty_do_not_ship": "0",
"ct3__cty_iso_number": "840",
"ct3__cty_bpa_region": "NORTH AMERICA",
"ct3__cty_do_not_sell": "0"
},
"Business_Fax_XRef": {
"cfx_fxt_key": "6b632577-c4ef-42ac-ae19-6dfe0ddece4b",
"cfx_primary": "1",
"cfx_owner": "1"
},
"Business_Fax": {
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Business_Fax_Country": {
"ct5__cty_code": "UNITED STATES",
"ct5__cty_add_date": "2001-12-05T13:44:00-06:00",
"ct5__cty_add_user": "XMEN\\tward",
"ct5__cty_change_date": "2007-07-11T16:51:42-05:00",
"ct5__cty_change_user": "skatragadda",
"ct5__cty_delete_flag": "0",
"ct5__cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct5__cty_key_ext": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct5__cty_long_name": "United States of America",
"ct5__cty_fips_code": "US",
"ct5__cty_status": "independent",
"ct5__cty_capital": "Washington, DC",
"ct5__cty_idd_code": "001",
"ct5__cty_postal_input_mask": "regex:\\d{5}(-\\d{4})?",
"ct5__cty_phone_input_mask": "^(\\d{3})(\\d{3})(\\d{4})$~($1)$2-$3",
"ct5__cty_currency_code": "USD",
"ct5__cty_currency_code_description": "U.S. Dollar",
"ct5__cty_vat_flag": "0",
"ct5__cty_iso_2": "US",
"ct5__cty_iso_3": "USA",
"ct5__cty_do_not_ship": "0",
"ct5__cty_iso_number": "840",
"ct5__cty_bpa_region": "NORTH AMERICA",
"ct5__cty_do_not_sell": "0"
},
"Home_Address_XRef": {
"cx2__cxa_primary": "0",
"cx2__cxa_owner": "0",
"cx2__cxa_billing": "0",
"cx2__cxa_create_change_log": "0"
},
"Home_Address": {
"ad2__adr_country": "UNITED STATES"
},
"Home_Address_State": null,
"Home_Address_Country": {
"ct2__cty_code": "UNITED STATES",
"ct2__cty_add_date": "2001-12-05T13:44:00-06:00",
"ct2__cty_add_user": "XMEN\\tward",
"ct2__cty_change_date": "2007-07-11T16:51:42-05:00",
"ct2__cty_change_user": "skatragadda",
"ct2__cty_delete_flag": "0",
"ct2__cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct2__cty_key_ext": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"ct2__cty_long_name": "United States of America",
"ct2__cty_fips_code": "US",
"ct2__cty_status": "independent",
"ct2__cty_capital": "Washington, DC",
"ct2__cty_idd_code": "001",
"ct2__cty_postal_input_mask": "regex:\\d{5}(-\\d{4})?",
"ct2__cty_phone_input_mask": "^(\\d{3})(\\d{3})(\\d{4})$~($1)$2-$3",
"ct2__cty_currency_code": "USD",
"ct2__cty_currency_code_description": "U.S. Dollar",
"ct2__cty_vat_flag": "0",
"ct2__cty_iso_2": "US",
"ct2__cty_iso_3": "USA",
"ct2__cty_do_not_ship": "0",
"ct2__cty_iso_number": "840",
"ct2__cty_bpa_region": "NORTH AMERICA",
"ct2__cty_do_not_sell": "0"
},
"Home_Phone": {
"ph2__phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Home_Phone_Country": null,
"Home_Phone_XRef": {
"cp2__cph_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"cp2__cph_pht_key": "88ff5661-2d14-4bdf-be4c-906c3bff7ef7",
"cp2__cph_primary": "0",
"cp2__cph_owner": "0"
},
"Home_Fax": {
"fa2__fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Home_Fax_Country": null,
"Home_Fax_XRef": {
"cf2__cfx_cst_key": "ec8ff4c0-f5a6-4812-b313-75dd5dba8fd1",
"cf2__cfx_fxt_key": "6b632577-c4ef-42ac-ae19-6dfe0ddece4b",
"cf2__cfx_primary": "0",
"cf2__cfx_owner": "0"
},
"Address_Change_Log": null,
"TransferToCustomer": null,
"Individual_Custom_Demographics": null,
"Social_Links": null,
"source_code": null
}
}