WEBAddressInsert
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
address object |
This method can be used to insert a new address for a customer.
Parameters
oFacadeObject (address object).
Response
This method returns the address object updated with keys which were inserted.
XML Method
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:WEBAddressInsert>
<ns:oFacadeObject>
[[Address Object]]
</ns:oFacadeObject>
</ns:WEBAddressInsert>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
A successful result returns a complete Address Object. A failure will result in an exception.
<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 xmlns="http://www.avectra.com/2005/">
<Token>f5b1fa51-8c70-4e2d-bee5-be4cf46afb4a</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBAddressUpdateResponse xmlns="http://www.avectra.com/2005/">
<WEBAddressUpdateResult>
<CurrentKey>... key GUID ...</CurrentKey>
<Address_XRef>
...
</Address_XRef>
<Customer>
...
</Customer>
... additional objects here ...
</WEBAddressUpdateResult>
</WEBAddressUpdateResponse>
</soap:Body>
</soap:Envelope>
JSON Method
Insert a new address for a customer.
See result from WEBAddressGet for all possible fields in the insert call.
GET n/a
POST /JSON/XWebREST/WEBAddressInsert
Copy
DATA: JSON
{
"WEBAddressInsert": {
"oFacadeObject": {
"CurrentKey": null,
"Address_XRef": {
"cxa_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cxa_adt_key": "0186a444-123c-4265-8746-67e813bb6746",
"cxa_primary": "0"
},
"Customer": {
"cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24"
},
"Address": {
"adr_cst_key_owner": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"adr_line1": "123 Main St",
"adr_line2": null,
"adr_city": "Houston",
"adr_state": "TX",
"adr_post_code": "77433",
"adr_country": "UNITED STATES"
}
}
}
}
Sample Response
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON{
"CustomerAddressType": {
"CurrentKey": "ce1428ed-dc64-4779-880e-5d5a18cd3826",
"Address_XRef": {
"cxa_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cxa_adr_key": "f75ee847-654c-458e-863b-a69da3323405",
"cxa_add_date": "2020-04-06T11:15:00-05:00",
"cxa_add_user": "jwatts",
"cxa_delete_flag": "0",
"cxa_key": "ce1428ed-dc64-4779-880e-5d5a18cd3826",
"cxa_key_ext": "ce1428ed-dc64-4779-880e-5d5a18cd3826",
"cxa_on_hold_flag": "0",
"cxa_adt_key": "0186a444-123c-4265-8746-67e813bb6746",
"cxa_mailing_label": "Mrs. Liza Grimshaw, CPPB, VCO, VCA Supplier and Contracts Specialist Medical University of South Carolina 123 Main St Houston, TX 77433",
"cxa_mailing_label_html": "Mrs. Liza Grimshaw, CPPB, VCO, VCA<br>Supplier and Contracts Specialist <br>Medical University of South Carolina<br>123 Main St<br>Houston, TX 77433",
"cxa_primary": "0",
"cxa_owner": "1",
"cxa_billing": "0",
"cxa_create_change_log": "0"
},
"Customer": {
"cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cst_type": "Individual",
"cst_name_cp": "Mrs. Liza Grimshaw, CPPB, VCO, VCA",
"cst_sort_name_dn": "Grimshaw Liza",
"cst_ind_full_name_dn": "Mrs. Liza Grimshaw, CPPB, VCO, VCA",
"cst_org_name_dn": "Medical University of South Carolina",
"cst_ixo_title_dn": "Supplier and Contracts Specialist ",
"cst_add_date": "2013-02-18T10:40:00-06:00",
"cst_add_user": "web:test@otitest.com",
"cst_change_date": "2020-04-04T23:25:00-05:00",
"cst_change_user": "jwatts",
"cst_delete_flag": "0",
"cst_recno": "109884",
"cst_id": "000109884I",
"cst_key_ext": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_cxa_key": "26ff8bc6-26c4-4177-8417-54b81a1b0ffb",
"cst_no_email_flag": "0",
"cst_eml_address_dn": "LizaGrimshaw3@otitest.com",
"cst_eml_key": "46538194-e963-4ffa-8c99-571e79594015",
"cst_no_phone_flag": "0",
"cst_phn_number_complete_dn": "843-792-8148",
"cst_cph_key": "de5f4824-b2cd-4ada-8334-03fde63894c3",
"cst_no_fax_flag": "0",
"cst_ixo_key": "b65f04bb-1f8b-4602-b9cb-465f848a45ed",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "0",
"cst_web_login": "LizaGrimshaw3@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-12-13T00:00:00-06:00",
"cst_no_publish_flag": "0",
"cst_salutation_1": "Mrs.. Liza Grimshaw CPPB, VCO, VCA",
"cst_salutation_2": "",
"cst_default_recognize_as": "Mrs.. Liza Grimshaw CPPB, VCO, VCA",
"cst_exclude_from_social_flag": "0"
},
"Individual": {
"ind_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"ind_prf_code": "Mrs.",
"ind_first_name": "Liza",
"ind_last_name": "Grimshaw",
"ind_designation": "CPPB, VCO, VCA",
"ind_gender": "Female",
"ind_full_name_cp": "Mrs. Liza Grimshaw, CPPB, VCO, VCA",
"ind_salutation_cp": "Mrs. Grimshaw",
"ind_cst_key_ext": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"ind_deceased_flag": "0",
"ind_add_date": "2013-02-18T10:40:00-06:00",
"ind_add_user": "web:test@otitest.com",
"ind_change_date": "2018-06-14T12:47:00-05:00",
"ind_change_user": "user",
"ind_delete_flag": "0",
"ind_disability_flag_ext": "0",
"ind_position_classification_ext": "Buyer",
"ind_department_ext": "Purchasing",
"ind_certificant_id_ext": "14497"
},
"Organization": {
"org_consortia_flag": "0"
},
"Chapter": null,
"Address": {
"adr_key": "f75ee847-654c-458e-863b-a69da3323405",
"adr_cst_key_owner": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"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-04-06T11:14:41-05:00",
"adr_add_user": "jwatts",
"adr_delete_flag": "0",
"adr_key_ext": "f75ee847-654c-458e-863b-a69da3323405",
"adr_bad_address_flag": "0",
"adr_no_validation_flag": "0"
},
"Address_Change_Log": {
"acl_key": "f62ed5fb-6528-4ed0-8134-b13859368afc",
"acl_adr_key": "f75ee847-654c-458e-863b-a69da3323405",
"acl_key_ext": "f62ed5fb-6528-4ed0-8134-b13859368afc",
"acl_new_mailing_label": "Mrs. Liza Grimshaw, CPPB, VCO, VCA Supplier and Contracts Specialist Medical University of South Carolina 123 Main St Houston, TX 77433",
"acl_new_mailing_label_html": "Mrs. Liza Grimshaw, CPPB, VCO, VCA<br>Supplier and Contracts Specialist <br>Medical University of South Carolina<br>123 Main St<br>Houston, TX 77433",
"acl_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24"
},
"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"
},
"Primary_Affiliation": {
"ixo_key": "b65f04bb-1f8b-4602-b9cb-465f848a45ed",
"ixo_rlt_code": "Supplemental",
"ixo_title": "Supplier and Contracts Specialist ",
"ixo_start_date": "2018-08-13T00:00:00-05:00",
"ixo_ind_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"ixo_org_cst_key": "66126d5e-44f9-4663-8ce7-f0b26bf4fc52",
"ixo_add_date": "2018-08-13T15:25:00-05:00",
"ixo_add_user": "user",
"ixo_rlt_key": "708073fe-abd6-459d-bcbb-7248e7d7a277",
"ixo_delete_flag": "0",
"ixo_key_ext": "b65f04bb-1f8b-4602-b9cb-465f848a45ed",
"ixo_void_flag": "0"
},
"StateTerritory": {
"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"
}
}
}