WEBAddressUpdate
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
boolean |
This method can be used to update a customer address. You can use the WEBAddressGet method to populate an address object, update the fields you need to update, and then send it back through this method.
Parameters
oFacadeObject (Address Object). This method accepts an address object as the only parameter. The CurrentKey property of the object indicates which record will be updated and is a required field. This value must correspond to a cxa_key value in the co_customer_x_address table. These values can be retrieved from WEBAddressGetAddressesByCustomer.
Response
A boolean value will be returned indicating if the update was successful.
Sample Request
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken soap:actor="5d66ef8b-55a5-4f34-848c-ee519d0a9f1f" xmlns="http://www.avectra.com/2005/">
<Token>1e664337-b300-49e9-987d-55d16edcda64</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBAddressUpdate xmlns="http://www.avectra.com/2005/">
<oFacadeObject>
<CurrentKey>937d0848-1325-405c-879b-9916e4dcd89e</CurrentKey>
<Address_XRef>
<cxa_cst_key>f19de971-5815-4d52-9be4-2d9008aa0070</cxa_cst_key>
<cxa_adr_key>9ea69f5d-ac12-4f8e-9930-a83ab7733164</cxa_adr_key>
<cxa_add_date>02/18/2010</cxa_add_date>
<cxa_add_user>skatragadda</cxa_add_user>
<cxa_change_date>03/01/2010</cxa_change_date>
<cxa_change_user>skatragadda</cxa_change_user>
<cxa_delete_flag>0</cxa_delete_flag>
<cxa_key>937d0848-1325-405c-879b-9916e4dcd89e</cxa_key>
<cxa_key_ext>937d0848-1325-405c-879b-9916e4dcd89e</cxa_key_ext>
<cxa_on_hold_flag>0</cxa_on_hold_flag>
<cxa_adh_key xsi:nil="true" />
<cxa_adt_key>927e7193-0184-4179-aeb7-0736d7ba6e0b</cxa_adt_key>
<cxa_seasonal_from_date xsi:nil="true" />
<cxa_mailing_label>ksrao91 katra 9650 Atlantic Blvd Jacksonville, FL 32225-8230 ksrao91@avectra.com</cxa_mailing_label>
<cxa_seasonal_through_date xsi:nil="true" />
<cxa_entity_key xsi:nil="true" />
<cxa_mail_stop xsi:nil="true" />
<cxa_mailing_label_html>ksrao91 katra<br>9650 Atlantic Blvd<br>Jacksonville, FL 32225-8230<br>ksrao91@avectra.com</cxa_mailing_label_html>
<cxa_on_hold_from xsi:nil="true" />
<cxa_on_hold_through xsi:nil="true" />
<cxa_primary>0</cxa_primary>
<cxa_owner>1</cxa_owner>
<cxa_billing>1</cxa_billing>
</Address_XRef>
<Customer>
<cst_key>f19de971-5815-4d52-9be4-2d9008aa0070</cst_key>
<cst_type>Individual</cst_type>
<cst_name_cp>ksrao91 katra</cst_name_cp>
<cst_sort_name_dn>katra ksrao91</cst_sort_name_dn>
<cst_ind_full_name_dn>ksrao91 katra</cst_ind_full_name_dn>
<cst_org_name_dn>Child Org</cst_org_name_dn>
<cst_ixo_title_dn xsi:nil="true" />
<cst_pref_comm_meth xsi:nil="true" />
<cst_bio xsi:nil="true" />
<cst_add_date>02/15/2010</cst_add_date>
<cst_add_user>skatragadda</cst_add_user>
<cst_change_date>03/02/2010</cst_change_date>
<cst_change_user>skatragadda</cst_change_user>
<cst_delete_flag>0</cst_delete_flag>
<cst_recno>83385</cst_recno>
<cst_id>000083385I</cst_id>
<cst_key_ext>f19de971-5815-4d52-9be4-2d9008aa0070</cst_key_ext>
<cst_email_text_only>0</cst_email_text_only>
<cst_credit_limit>0.00</cst_credit_limit>
<cst_src_code xsi:nil="true" />
<cst_tax_exempt_flag>0</cst_tax_exempt_flag>
<cst_tax_id xsi:nil="true" />
<cst_cxa_key>353e3aaa-4420-4cf6-8389-78303a7f46f9</cst_cxa_key>
<cst_no_email_flag>0</cst_no_email_flag>
<cst_cxa_billing_key>937d0848-1325-405c-879b-9916e4dcd89e</cst_cxa_billing_key>
<cst_eml_address_dn>ksrao91@avectra.com</cst_eml_address_dn>
<cst_eml_key>0c9b4da4-84b0-4cce-81f5-80427c601c68</cst_eml_key>
<cst_no_phone_flag>0</cst_no_phone_flag>
<cst_phn_number_complete_dn xsi:nil="true" />
<cst_cph_key xsi:nil="true" />
<cst_no_fax_flag>0</cst_no_fax_flag>
<cst_fax_number_complete_dn xsi:nil="true" />
<cst_cfx_key xsi:nil="true" />
<cst_ixo_key>2bd7884a-c118-40a5-8b1a-205821daa790</cst_ixo_key>
<cst_no_web_flag>0</cst_no_web_flag>
<cst_oldid xsi:nil="true" />
<cst_member_flag>0</cst_member_flag>
<cst_url_code_dn xsi:nil="true" />
<cst_parent_cst_key xsi:nil="true" />
<cst_url_key xsi:nil="true" />
<cst_no_msg_flag>0</cst_no_msg_flag>
<cst_msg_handle_dn xsi:nil="true" />
<cst_web_login xsi:nil="true" />
<cst_web_password>81dc9bdb52d04dc2036dbd8313ed055</cst_web_password>
<cst_entity_key xsi:nil="true" />
<cst_msg_key xsi:nil="true" />
<cst_no_mail_flag>0</cst_no_mail_flag>
<cst_web_start_date xsi:nil="true" />
<cst_web_end_date xsi:nil="true" />
<cst_web_force_password_change>0</cst_web_force_password_change>
<cst_web_login_disabled_flag>0</cst_web_login_disabled_flag>
<cst_comment xsi:nil="true" />
<cst_credit_hold_flag>0</cst_credit_hold_flag>
<cst_credit_hold_reason xsi:nil="true" />
<cst_web_forgot_password_status>0</cst_web_forgot_password_status>
<cst_old_cxa_key xsi:nil="true" />
<cst_last_email_date xsi:nil="true" />
<cst_no_publish_flag>0</cst_no_publish_flag>
<cst_sin_key xsi:nil="true" />
<cst_ttl_key xsi:nil="true" />
<cst_jfn_key xsi:nil="true" />
<cst_cur_key xsi:nil="true" />
<cst_attribute_1 xsi:nil="true" />
<cst_attribute_2 xsi:nil="true" />
</Customer>
<Individual>
<ind_cst_key>f19de971-5815-4d52-9be4-2d9008aa0070</ind_cst_key>
<ind_prf_code xsi:nil="true" />
<ind_first_name>ksrao91</ind_first_name>
<ind_mid_name xsi:nil="true" />
<ind_last_name>katra</ind_last_name>
<ind_sfx_code xsi:nil="true" />
<ind_designation xsi:nil="true" />
<ind_dob xsi:nil="true" />
<ind_gender xsi:nil="true" />
<ind_full_name_cp>ksrao91 katra</ind_full_name_cp>
<ind_salutation_cp xsi:nil="true" />
<ind_cst_key_ext>f19de971-5815-4d52-9be4-2d9008aa0070</ind_cst_key_ext>
<ind_ssn xsi:nil="true" />
<ind_spouse_name xsi:nil="true" />
<ind_age_cp xsi:nil="true" />
<ind_salary>0.00</ind_salary>
<ind_ethnicity xsi:nil="true" />
<ind_badge_name>ksrao91</ind_badge_name>
<ind_license_number xsi:nil="true" />
<ind_entered_field_date xsi:nil="true" />
<ind_num_years_in_field_cp xsi:nil="true" />
<ind_grad_date xsi:nil="true" />
<ind_political_party xsi:nil="true" />
<ind_deceased_flag>0</ind_deceased_flag>
<ind_int_code xsi:nil="true" />
<ind_ixo_key xsi:nil="true" />
<ind_marital_status xsi:nil="true" />
<ind_add_date>02/15/2010</ind_add_date>
<ind_add_user>skatragadda</ind_add_user>
<ind_entity_key xsi:nil="true" />
<ind_change_date>03/02/2010</ind_change_date>
<ind_cst_passcode_ext xsi:nil="true" />
<ind_change_user>skatragadda</ind_change_user>
<ind_sample_multi xsi:nil="true" />
<ind_delete_flag>0</ind_delete_flag>
<ind_maiden_name xsi:nil="true" />
<ind_popup xsi:nil="true" />
</Individual>
<Address>
<adr_key>9ea69f5d-ac12-4f8e-9930-a83ab7733164</adr_key>
<adr_cst_key_owner>f19de971-5815-4d52-9be4-2d9008aa0070</adr_cst_key_owner>
<adr_line1>9650 Atlantic Blvd 1</adr_line1>
<adr_line2 />
<adr_line3 />
<adr_city>Jacksonville</adr_city>
<adr_state>FL</adr_state>
<adr_post_code>32225-8230</adr_post_code>
<adr_city_state_code>Jacksonville, FL 32225-8230</adr_city_state_code>
<adr_country>UNITED STATES</adr_country>
<adr_intl_province />
<adr_county>Duval</adr_county>
<adr_cong_dist />
<adr_state_house xsi:nil="true" />
<adr_state_senate xsi:nil="true" />
<adr_latitude>30.32164</adr_latitude>
<adr_longitude>-81.548712</adr_longitude>
<adr_mailing_label xsi:nil="true" />
<adr_mailing_label_html xsi:nil="true" />
<adr_add_date>02/18/2010</adr_add_date>
<adr_add_user>skatragadda</adr_add_user>
<adr_change_date>2/18/2010 3:16:36 PM</adr_change_date>
<adr_change_user>skatragadda</adr_change_user>
<adr_delete_flag>0</adr_delete_flag>
<adr_key_ext>9ea69f5d-ac12-4f8e-9930-a83ab7733164</adr_key_ext>
<adr_bad_address_flag>0</adr_bad_address_flag>
<adr_adb_key xsi:nil="true" />
<adr_entity_key xsi:nil="true" />
<adr_metro_stat_area xsi:nil="true" />
<adr_carrier_route>C040</adr_carrier_route>
<adr_delivery_point_code>YN</adr_delivery_point_code>
<adr_lacs xsi:nil="true" />
<adr_time_zone>EST</adr_time_zone>
<adr_urbanization xsi:nil="true" />
<adr_bar_code>322258230508</adr_bar_code>
<adr_fips>12031</adr_fips>
<adr_no_validation_flag>0</adr_no_validation_flag>
</Address>
<Country>
<cty_code>UNITED STATES</cty_code>
<cty_add_date>12/05/2001</cty_add_date>
<cty_add_user>XMEN\tward</cty_add_user>
<cty_change_date>03/23/2009</cty_change_date>
<cty_change_user>hgallion</cty_change_user>
<cty_delete_flag>0</cty_delete_flag>
<cty_key>bc4b70f8-280e-4bb0-b935-9f728c50e183</cty_key>
<cty_key_ext>bc4b70f8-280e-4bb0-b935-9f728c50e183</cty_key_ext>
<cty_entity_key xsi:nil="true" />
<cty_long_name>United States of America</cty_long_name>
<cty_fips_code>US</cty_fips_code>
<cty_sovereignty xsi:nil="true" />
<cty_status>independent</cty_status>
<cty_capital>Washington, DC</cty_capital>
<cty_idd_code>001</cty_idd_code>
<cty_rgn_key>5c19c7fa-a5ab-4ace-934c-7e86d9169015</cty_rgn_key>
<cty_srg_key xsi:nil="true" />
<cty_postal_input_mask>regex:\d{5}(-\d{4})?</cty_postal_input_mask>
<cty_phone_input_mask>^(\d{3})(\d{3})(\d{4})$~($1)$2-$3</cty_phone_input_mask>
<cty_currency_code>USD</cty_currency_code>
<cty_currency_code_description>U.S. Dollar</cty_currency_code_description>
<cty_vat_flag>0</cty_vat_flag>
<cty_iso_2>US</cty_iso_2>
<cty_iso_3>USA</cty_iso_3>
<cty_do_not_ship>0</cty_do_not_ship>
<cty_iso_number>840</cty_iso_number>
</Country>
<Primary_Affiliation>
<ixo_key>2bd7884a-c118-40a5-8b1a-205821daa790</ixo_key>
<ixo_rlt_code>Staff</ixo_rlt_code>
<ixo_title xsi:nil="true" />
<ixo_start_date xsi:nil="true" />
<ixo_end_date xsi:nil="true" />
<ixo_ind_cst_key>f19de971-5815-4d52-9be4-2d9008aa0070</ixo_ind_cst_key>
<ixo_org_cst_key>568fcc19-1698-4b9c-a3d6-15e5fe849aa0</ixo_org_cst_key>
<ixo_add_date>03/02/2010</ixo_add_date>
<ixo_add_user>skatragadda</ixo_add_user>
<ixo_change_date xsi:nil="true" />
<ixo_change_user xsi:nil="true" />
<ixo_delete_flag>0</ixo_delete_flag>
<ixo_key_ext>2bd7884a-c118-40a5-8b1a-205821daa790</ixo_key_ext>
<ixo_cst_key_owner xsi:nil="true" />
<ixo_entity_key xsi:nil="true" />
</Primary_Affiliation>
</oFacadeObject>
</WEBAddressUpdate>
</soap:Body>
</soap:Envelope>
Setting the Change Log Reason
To set the address change log reason, include a node like this, substituting the appropriate values:<ns:Address_Change_Log>
<ns:acl_adr_key>E4F0FE6E-DB9E-439A-A2F2-9D50036D8BF9</ns:acl_adr_key>
<ns:acl_adn_key>4893329F-BCCA-4B3F-B838-B49397C78676</ns:acl_adn_key>
<ns:acl_cst_key>4ae38161-c338-43d1-b6a9-8ebfe13df0df</ns:acl_cst_key>
</ns:Address_Change_Log>
Sample Response
<?xml version="1.0" encoding="utf-16"?>
<boolean>true</boolean>
JSON Method
Update the address record for a customer.
See result from WEBAddressGet for all possible fields in the update call.
GET n/a
POST /JSON/XWebREST/WEBAddressUpdate
Copy
DATA: JSON
EXAMPLE: Update the address type, street, and zip
DATA: JSON{
"WEBAddressUpdate": {
"oFacadeObject": {
"CurrentKey": "ce1428ed-dc64-4779-880e-5d5a18cd3826",
"Address_XRef": {
"cxa_key": "ce1428ed-dc64-4779-880e-5d5a18cd3826",
"cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f"
},
"Address": {
"adr_key": "f75ee847-654c-458e-863b-a69da3323405",
"adr_line1": "100 5th St",
"adr_post_code": "77435"
}
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
true