WEBFaxInsert
| Initial Build | 2008.01 |
| xWeb | Web Method |
| Response Type | XML results |
This method can be used to add a new fax number to a customer record.
Parameters
Customer record with new fax number included.Response
XML results that include the added fax number key.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>?</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBFaxInsert>
<!--Optional:-->
<ns:oFacadeObject>
<ns:Fax_XRef>
<ns:cfx_key>?</ns:cfx_key>
<ns:cfx_cst_key>?</ns:cfx_cst_key>
<ns:cfx_fax_key>?</ns:cfx_fax_key>
<ns:cfx_fxt_key>?</ns:cfx_fxt_key>
<ns:cfx_cst_link_key>?</ns:cfx_cst_link_key>
<ns:cfx_add_user>?</ns:cfx_add_user>
<ns:cfx_add_date>?</ns:cfx_add_date>
<ns:cfx_change_user>?</ns:cfx_change_user>
<ns:cfx_change_date>?</ns:cfx_change_date>
<ns:cfx_delete_flag>?</ns:cfx_delete_flag>
<ns:cfx_key_ext>?</ns:cfx_key_ext>
<ns:cfx_unlisted_flag>?</ns:cfx_unlisted_flag>
<ns:cfx_fax_number_complete>?</ns:cfx_fax_number_complete>
<ns:cfx_extension>?</ns:cfx_extension>
<ns:cfx_entity_key>?</ns:cfx_entity_key>
<ns:cfx_primary>?</ns:cfx_primary>
<ns:cfx_owner>?</ns:cfx_owner>
</ns:Fax_XRef>
<ns:Customer>
<ns:cst_key>?</ns:cst_key>
<ns:cst_type>?</ns:cst_type>
<ns:cst_name_cp>?</ns:cst_name_cp>
<ns:cst_sort_name_dn>?</ns:cst_sort_name_dn>
<ns:cst_ind_full_name_dn>?</ns:cst_ind_full_name_dn>
<ns:cst_org_name_dn>?</ns:cst_org_name_dn>
<ns:cst_ixo_title_dn>?</ns:cst_ixo_title_dn>
<ns:cst_pref_comm_meth>?</ns:cst_pref_comm_meth>
<ns:cst_bio>?</ns:cst_bio>
<ns:cst_add_date>?</ns:cst_add_date>
<ns:cst_add_user>?</ns:cst_add_user>
<ns:cst_change_date>?</ns:cst_change_date>
<ns:cst_change_user>?</ns:cst_change_user>
<ns:cst_delete_flag>?</ns:cst_delete_flag>
<ns:cst_recno>?</ns:cst_recno>
<ns:cst_id>?</ns:cst_id>
<ns:cst_key_ext>?</ns:cst_key_ext>
<ns:cst_email_text_only>?</ns:cst_email_text_only>
<ns:cst_credit_limit>?</ns:cst_credit_limit>
<ns:cst_src_code>?</ns:cst_src_code>
<ns:cst_tax_exempt_flag>?</ns:cst_tax_exempt_flag>
<ns:cst_tax_id>?</ns:cst_tax_id>
<ns:cst_no_email_flag>?</ns:cst_no_email_flag>
<ns:cst_cxa_key>?</ns:cst_cxa_key>
<ns:cst_cxa_billing_key>?</ns:cst_cxa_billing_key>
<ns:cst_eml_address_dn>?</ns:cst_eml_address_dn>
<ns:cst_eml_key>?</ns:cst_eml_key>
<ns:cst_no_phone_flag>?</ns:cst_no_phone_flag>
<ns:cst_phn_number_complete_dn>?</ns:cst_phn_number_complete_dn>
<ns:cst_cph_key>?</ns:cst_cph_key>
<ns:cst_no_fax_flag>?</ns:cst_no_fax_flag>
<ns:cst_fax_number_complete_dn>?</ns:cst_fax_number_complete_dn>
<ns:cst_cfx_key>?</ns:cst_cfx_key>
<ns:cst_ixo_key>?</ns:cst_ixo_key>
<ns:cst_oldid>?</ns:cst_oldid>
<ns:cst_no_web_flag>?</ns:cst_no_web_flag>
<ns:cst_url_code_dn>?</ns:cst_url_code_dn>
<ns:cst_member_flag>?</ns:cst_member_flag>
<ns:cst_url_key>?</ns:cst_url_key>
<ns:cst_parent_cst_key>?</ns:cst_parent_cst_key>
<ns:cst_no_msg_flag>?</ns:cst_no_msg_flag>
<ns:cst_msg_handle_dn>?</ns:cst_msg_handle_dn>
<ns:cst_web_login>?</ns:cst_web_login>
<ns:cst_web_password>?</ns:cst_web_password>
<ns:cst_msg_key>?</ns:cst_msg_key>
<ns:cst_entity_key>?</ns:cst_entity_key>
<ns:cst_web_start_date>?</ns:cst_web_start_date>
<ns:cst_no_mail_flag>?</ns:cst_no_mail_flag>
<ns:cst_web_end_date>?</ns:cst_web_end_date>
<ns:cst_web_force_password_change>?</ns:cst_web_force_password_change>
<ns:cst_web_login_disabled_flag>?</ns:cst_web_login_disabled_flag>
<ns:cst_comment>?</ns:cst_comment>
<ns:cst_credit_hold_flag>?</ns:cst_credit_hold_flag>
<ns:cst_credit_hold_reason>?</ns:cst_credit_hold_reason>
<ns:cst_web_forgot_password_status>?</ns:cst_web_forgot_password_status>
<ns:cst_old_cxa_key>?</ns:cst_old_cxa_key>
<ns:cst_last_email_date>?</ns:cst_last_email_date>
<ns:cst_no_publish_flag>?</ns:cst_no_publish_flag>
<ns:cst_sin_key>?</ns:cst_sin_key>
<ns:cst_ttl_key>?</ns:cst_ttl_key>
<ns:cst_jfn_key>?</ns:cst_jfn_key>
<ns:cst_cur_key>?</ns:cst_cur_key>
<ns:cst_attribute_1>?</ns:cst_attribute_1>
<ns:cst_attribute_2>?</ns:cst_attribute_2>
</ns:Customer>
<ns:Fax>
<ns:fax_key>?</ns:fax_key>
<ns:fax_cst_key_owner>?</ns:fax_cst_key_owner>
<ns:fax_number>?</ns:fax_number>
<ns:fax_number_display>?</ns:fax_number_display>
<ns:fax_cty_key>?</ns:fax_cty_key>
<ns:fax_add_user>?</ns:fax_add_user>
<ns:fax_add_date>?</ns:fax_add_date>
<ns:fax_change_user>?</ns:fax_change_user>
<ns:fax_change_date>?</ns:fax_change_date>
<ns:fax_delete_flag>?</ns:fax_delete_flag>
<ns:fax_entity_key>?</ns:fax_entity_key>
<ns:fax_key_ext>?</ns:fax_key_ext>
</ns:Fax>
<ns:Country>
<ns:cty_code>?</ns:cty_code>
<ns:cty_add_date>?</ns:cty_add_date>
<ns:cty_add_user>?</ns:cty_add_user>
<ns:cty_change_date>?</ns:cty_change_date>
<ns:cty_change_user>?</ns:cty_change_user>
<ns:cty_delete_flag>?</ns:cty_delete_flag>
<ns:cty_key>?</ns:cty_key>
<ns:cty_key_ext>?</ns:cty_key_ext>
<ns:cty_entity_key>?</ns:cty_entity_key>
<ns:cty_long_name>?</ns:cty_long_name>
<ns:cty_fips_code>?</ns:cty_fips_code>
<ns:cty_sovereignty>?</ns:cty_sovereignty>
<ns:cty_status>?</ns:cty_status>
<ns:cty_capital>?</ns:cty_capital>
<ns:cty_idd_code>?</ns:cty_idd_code>
<ns:cty_rgn_key>?</ns:cty_rgn_key>
<ns:cty_srg_key>?</ns:cty_srg_key>
<ns:cty_postal_input_mask>?</ns:cty_postal_input_mask>
<ns:cty_phone_input_mask>?</ns:cty_phone_input_mask>
<ns:cty_currency_code>?</ns:cty_currency_code>
<ns:cty_currency_code_description>?</ns:cty_currency_code_description>
<ns:cty_vat_flag>?</ns:cty_vat_flag>
<ns:cty_iso_2>?</ns:cty_iso_2>
<ns:cty_iso_3>?</ns:cty_iso_3>
<ns:cty_iso_number>?</ns:cty_iso_number>
<ns:cty_do_not_ship>?</ns:cty_do_not_ship>
</ns:Country>
</ns:oFacadeObject>
</ns:WEBFaxInsert>
</soapenv:Body>
</soapenv:Envelope>Sample Response
The response columns match the request columns. netFORUM generates and returns the keys for the new fax number.
JSON Method
Insert a new fax number for a customer.
See result from WEBFaxGet for all possible fields in the insert call.
GET n/a
POST /xweb/JSON/WEBFaxInsert
DATA: JSON
{
"WEBFaxInsert": {
"oFacadeObject": {
"CurrentKey": null,
"Customer": {
"cst_key": "ba858a26-c404-46a9-abfc-07af40fed8de"
},
"Fax_XRef": {
"cfx_cst_key": "ba858a26-c404-46a9-abfc-07af40fed8de",
"cfx_fxt_key": "1e583faf-f85b-4df0-b9c1-fd4b696560b9",
"cfx_unlisted_flag": "0",
"cfx_primary": "0"
},
"Fax": {
"fax_cst_key_owner": "ba858a26-c404-46a9-abfc-07af40fed8de",
"fax_number": "8885551212",
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
}
}
}
}SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"CustomerFaxType": {
"CurrentKey": "6f4d411e-2e04-4174-8b00-fb6b8315f614",
"Fax_XRef": {
"cfx_key": "6f4d411e-2e04-4174-8b00-fb6b8315f614",
"cfx_cst_key": "ba858a26-c404-46a9-abfc-07af40fed8de",
"cfx_fax_key": "35807858-7cd1-40b3-8a3e-54f16f276ffb",
"cfx_fxt_key": "1e583faf-f85b-4df0-b9c1-fd4b696560b9",
"cfx_add_user": "jwatts",
"cfx_add_date": "2020-04-06T11:58:27-05:00",
"cfx_delete_flag": "0",
"cfx_key_ext": "6f4d411e-2e04-4174-8b00-fb6b8315f614",
"cfx_unlisted_flag": "0",
"cfx_fax_number_complete": "(888)555-1212",
"cfx_primary": "0",
"cfx_owner": "1"
},
"Customer": {
"cst_key": "ba858a26-c404-46a9-abfc-07af40fed8de",
"cst_type": "Individual",
"cst_name_cp": "Mr. Barry Wolfgang",
"cst_sort_name_dn": "Wolfgang Barry",
"cst_ind_full_name_dn": "Mr. Barry Wolfgang",
"cst_org_name_dn": "City of Dover - DE",
"cst_ixo_title_dn": "Contract and Procurement Manager",
"cst_pref_comm_meth": "E-Mail",
"cst_add_date": "2011-07-08T12:16:00-05:00",
"cst_add_user": "web:test@otitest.com",
"cst_change_date": "2019-11-08T08:45:00-06:00",
"cst_change_user": "user",
"cst_delete_flag": "0",
"cst_recno": "102779",
"cst_id": "000102779I",
"cst_key_ext": "ba858a26-c404-46a9-abfc-07af40fed8de",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_cxa_key": "59b2fb77-695b-489e-8b5c-a384acf06474",
"cst_no_email_flag": "0",
"cst_cxa_billing_key": "a88e9763-ba79-4e15-9e90-265ba819adc5",
"cst_eml_address_dn": "BarryWolfgang1@otitest.com",
"cst_eml_key": "d98b81a1-2f8e-46d1-804d-461333078b3a",
"cst_no_phone_flag": "0",
"cst_phn_number_complete_dn": "(302)736-7795",
"cst_cph_key": "c5512e68-356a-49a5-b8a5-2dd6df4ada75",
"cst_no_fax_flag": "1",
"cst_fax_number_complete_dn": "(302)736-7178",
"cst_cfx_key": "96e7008c-eed9-4b84-8c86-e37c4b8f16ea",
"cst_ixo_key": "b735a942-f459-403b-98ce-9b07bc010b8d",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "1",
"cst_web_login": "BarryWolfgang1@otitest.com",
"cst_web_password": "fc5c60e877f0a5cd69d7a0c48720bd4",
"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_last_email_date": "2019-11-08T00:00:00-06:00",
"cst_no_publish_flag": "0",
"cst_salutation_1": "Mr.. Barry Wolfgang ",
"cst_salutation_2": "Mr.. Barry Wolfgang ",
"cst_default_recognize_as": "Mr.. Barry Wolfgang ",
"cst_exclude_from_social_flag": "0"
},
"Fax": {
"fax_key": "35807858-7cd1-40b3-8a3e-54f16f276ffb",
"fax_cst_key_owner": "ba858a26-c404-46a9-abfc-07af40fed8de",
"fax_number": "8885551212",
"fax_number_display": "(888)555-1212",
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"fax_add_user": "jwatts",
"fax_add_date": "2020-04-06T11:58:27-05:00",
"fax_delete_flag": "0",
"fax_key_ext": "35807858-7cd1-40b3-8a3e-54f16f276ffb"
},
"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"
}
}
}