WEBAddressGet
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
Address Object |
This method returns an Address Object for the customer's specified address.
Parameters
key (guid). The primary key of a co_customer_x_address record which is cxa_key. Call WEBAddressGetAddressesByCustomer to get a list of a customer's addresses, each of which will contain the cxa_key property.
Response
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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBAddressGet>
<ns:key>9fe461a4-ed24-49d8-be1d-36e0c378705e</ns:key>
</ns:WEBAddressGet>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
Shortened for brevity.
<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>2306bae2-4f6f-499c-8b8b-daffb79abb9b</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBAddressGetResponse xmlns="http://www.avectra.com/2005/">
<WEBAddressGetResult>
<Address_XRef>
<cxa_cst_key>207d1a31-567e-4a97-ac21-a1923a092755</cxa_cst_key>
<cxa_adr_key>1e540819-449a-4c57-8810-6df8276635ca</cxa_adr_key>
<cxa_add_date>10/10/2008</cxa_add_date>
<cxa_add_user>hstechl</cxa_add_user>
<cxa_change_date>10/10/2008</cxa_change_date>
<cxa_change_user>jmalin</cxa_change_user>
<cxa_delete_flag>0</cxa_delete_flag>
<cxa_key>9fe461a4-ed24-49d8-be1d-36e0c378705e</cxa_key>
<cxa_key_ext>9fe461a4-ed24-49d8-be1d-36e0c378705e</cxa_key_ext>
<cxa_on_hold_flag>0</cxa_on_hold_flag>
<cxa_adt_key>48044466-bf02-47c5-bb7a-9a1282194659</cxa_adt_key>
<cxa_mailing_label>Robert Smith 7901 Jones Branch Dr Mclean, VA 22102-3338</cxa_mailing_label>
<cxa_mailing_label_html>Robert Smith<br>7901 Jones Branch Dr<br>Mclean, VA 22102-3338</cxa_mailing_label_html>
<cxa_primary>1</cxa_primary>
<cxa_owner>1</cxa_owner>
<cxa_billing>1</cxa_billing>
</Address_XRef>
<Customer>
<cst_key>207d1a31-567e-4a97-ac21-a1923a092755</cst_key>
<cst_type>Individual</cst_type>
<cst_name_cp>Robert Smith</cst_name_cp>
<cst_sort_name_dn>Smith Robert</cst_sort_name_dn>
<cst_ind_full_name_dn>Robert Smith</cst_ind_full_name_dn>
<cst_add_date>10/10/2008</cst_add_date>
<cst_add_user>hstechl</cst_add_user>
<cst_change_date>10/10/2008</cst_change_date>
<cst_change_user>hstechl</cst_change_user>
<cst_delete_flag>0</cst_delete_flag>
<cst_recno>82896</cst_recno>
<cst_id>000082896I</cst_id>
<cst_key_ext>207d1a31-567e-4a97-ac21-a1923a092755</cst_key_ext>
<cst_email_text_only>0</cst_email_text_only>
<cst_credit_limit>0.00</cst_credit_limit>
<cst_tax_exempt_flag>0</cst_tax_exempt_flag>
<cst_no_email_flag>0</cst_no_email_flag>
<cst_cxa_key>9fe461a4-ed24-49d8-be1d-36e0c378705e</cst_cxa_key>
<cst_cxa_billing_key>9fe461a4-ed24-49d8-be1d-36e0c378705e</cst_cxa_billing_key>
<cst_eml_address_dn>bsmith@avectra.com</cst_eml_address_dn>
<cst_eml_key>25b22341-56d6-437a-a963-8e7e29305806</cst_eml_key>
<cst_no_phone_flag>0</cst_no_phone_flag>
<cst_phn_number_complete_dn>(703)506-7000</cst_phn_number_complete_dn>
<cst_cph_key>d31b3993-03d8-4372-ba57-86998acbcd61</cst_cph_key>
<cst_no_fax_flag>1</cst_no_fax_flag>
<cst_fax_number_complete_dn>(703)506-7001</cst_fax_number_complete_dn>
<cst_cfx_key>da38128d-f80d-4871-9fe5-d708960aaa1b</cst_cfx_key>
<cst_no_web_flag>0</cst_no_web_flag>
<cst_member_flag>0</cst_member_flag>
<cst_no_msg_flag>1</cst_no_msg_flag>
<cst_web_login>bsmith</cst_web_login>
<cst_web_password>202cb962ac5975b964b7152d234b70</cst_web_password>
<cst_no_mail_flag>0</cst_no_mail_flag>
<cst_web_force_password_change>0</cst_web_force_password_change>
<cst_web_login_disabled_flag>0</cst_web_login_disabled_flag>
<cst_credit_hold_flag>0</cst_credit_hold_flag>
<cst_web_forgot_password_status>0</cst_web_forgot_password_status>
<cst_no_publish_flag>0</cst_no_publish_flag>
</Customer>
<Individual>
<ind_cst_key>207d1a31-567e-4a97-ac21-a1923a092755</ind_cst_key>
<ind_first_name>Robert</ind_first_name>
<ind_last_name>Smith</ind_last_name>
<ind_full_name_cp>Robert Smith</ind_full_name_cp>
<ind_cst_key_ext>207d1a31-567e-4a97-ac21-a1923a092755</ind_cst_key_ext>
<ind_salary>0.00</ind_salary>
<ind_deceased_flag>0</ind_deceased_flag>
<ind_add_date>10/10/2008</ind_add_date>
<ind_add_user>hstechl</ind_add_user>
<ind_change_date>10/10/2008</ind_change_date>
<ind_change_user>hstechl</ind_change_user>
<ind_delete_flag>0</ind_delete_flag>
</Individual>
<Address>
<adr_key>1e540819-449a-4c57-8810-6df8276635ca</adr_key>
<adr_cst_key_owner>207d1a31-567e-4a97-ac21-a1923a092755</adr_cst_key_owner>
<adr_line1>7901 Jones Branch Dr</adr_line1>
<adr_city>Mclean</adr_city>
<adr_state>VA</adr_state>
<adr_post_code>22102-3338</adr_post_code>
<adr_city_state_code>Mclean, VA 22102-3338</adr_city_state_code>
<adr_country>UNITED STATES</adr_country>
<adr_county>Fairfax</adr_county>
<adr_cong_dist>8</adr_cong_dist>
<adr_state_house>032</adr_state_house>
<adr_state_senate>034</adr_state_senate>
<adr_latitude>38.9289955</adr_latitude>
<adr_longitude>-77.219134</adr_longitude>
<adr_add_date>10/10/2008</adr_add_date>
<adr_add_user>hstechl</adr_add_user>
<adr_change_date>10/10/2008 4:34:07 PM</adr_change_date>
<adr_change_user>jmalin</adr_change_user>
<adr_delete_flag>0</adr_delete_flag>
<adr_key_ext>1e540819-449a-4c57-8810-6df8276635ca</adr_key_ext>
<adr_bad_address_flag>0</adr_bad_address_flag>
<adr_metro_stat_area>8840</adr_metro_stat_area>
<adr_carrier_route>C020</adr_carrier_route>
<adr_delivery_point_code>99</adr_delivery_point_code>
<adr_time_zone>EST</adr_time_zone>
<adr_bar_code>f221023338998f</adr_bar_code>
<adr_fips>51059</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>08/06/2008</cty_change_date>
<cty_change_user>obilby</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_long_name>United States of America</cty_long_name>
<cty_fips_code>US</cty_fips_code>
<cty_status>independent</cty_status>
<cty_capital>Washington, DC</cty_capital>
<cty_idd_code>001</cty_idd_code>
<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_iso_number>840</cty_iso_number>
<cty_do_not_ship>0</cty_do_not_ship>
</Country>
</WEBAddressGetResult>
</WEBAddressGetResponse>
</soap:Body>
</soap:Envelope>
JSON Method
Get the full details of an address using the customer X address key (cxa_key).
Use the WEBAddressGetAddressesByCustomer call to get all addresses for a given customer key.
GET /xweb/JSON/WEBAddressGet?key=26ff8bc6-26c4-4177-8417-54b81a1b0ffb
POST /JSON/XWebREST/WEBAddressGet
Copy
DATA: JSON
{
"WEBAddressGet": {
"key": "26ff8bc6-26c4-4177-8417-54b81a1b0ffb"
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON{
"CustomerAddressType": {
"CurrentKey": "26ff8bc6-26c4-4177-8417-54b81a1b0ffb",
"Address_XRef": {
"cxa_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cxa_adr_key": "04faae58-3674-4fba-bc08-29e63e374ae6",
"cxa_add_date": "2013-02-18T10:40:00-06:00",
"cxa_add_user": "web:test@otitest.com",
"cxa_change_date": "2019-12-10T09:06:00-06:00",
"cxa_change_user": "web:test@otitest.com",
"cxa_delete_flag": "0",
"cxa_key": "26ff8bc6-26c4-4177-8417-54b81a1b0ffb",
"cxa_key_ext": "26ff8bc6-26c4-4177-8417-54b81a1b0ffb",
"cxa_on_hold_flag": "0",
"cxa_adt_key": "e09fc2cf-5f86-46cd-9c31-f215018ba99f",
"cxa_mailing_label": "Mrs. Liza Grimshaw, CPPB, VCO, VCA Supplier and Contracts Specialist Medical University of South Carolina 1 Southpark Circle Suite 501 Charleston, SC 29407",
"cxa_mailing_label_html": "Mrs. Liza Grimshaw, CPPB, VCO, VCA<br>Supplier and Contracts Specialist <br>Medical University of South Carolina<br>1 Southpark Circle<br>Suite 501<br>Charleston, SC 29407",
"cxa_primary": "1",
"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": "04faae58-3674-4fba-bc08-29e63e374ae6",
"adr_cst_key_owner": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"adr_line1": "1 Southpark Circle",
"adr_line2": "Suite 501",
"adr_city": "Charleston",
"adr_state": "SC",
"adr_post_code": "29407",
"adr_city_state_code": "Charleston, SC 29407",
"adr_country": "UNITED STATES",
"adr_mailing_label": "312 Cedar Rd. P.O. Box 16496 Chesapeake, VA 23328-6496 ",
"adr_mailing_label_html": "312 Cedar Rd.<br>P.O. Box 16496<br>Chesapeake, VA 23328-6496<br>",
"adr_add_date": "2013-02-18T10:40:17-06:00",
"adr_add_user": "web:test@otitest.com",
"adr_change_date": "2019-12-10T09:06:26-06:00",
"adr_change_user": "web:test@otitest.com",
"adr_delete_flag": "0",
"adr_key_ext": "04faae58-3674-4fba-bc08-29e63e374ae6",
"adr_bad_address_flag": "0",
"adr_no_validation_flag": "0"
},
"Address_Change_Log": null,
"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": "SC",
"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:20:00-06:00",
"sta_change_user": "LRiegelman",
"sta_delete_flag": "0",
"sta_key": "6bbc01d3-dedb-432c-9abd-5538166ea623",
"sta_key_ext": "6bbc01d3-dedb-432c-9abd-5538166ea623",
"sta_name": "South Carolina",
"sta_type": "state",
"sta_rgn_key": "5d9fc249-4fe9-4e9d-9d83-d94004a5f4a7",
"sta_bpa_region": "SOUTH ATLANTIC"
}
}
}