WEBIndividualGet
|
Initial Build |
2008.01 |
|
xWEB |
Web Method |
|
Response Type |
object |
The WEBIndividualGet web method returns information about an Individual.
Parameters
The request contains the following required parameter:
| Name | Type | Occurs | Description |
|---|---|---|---|
| key | guid | 1..1 | The Customer Key of the individual. |
Response
This method returns a IndividualType, which is an Individual object, with the data populated for the individual corresponding to the value passed as the Key parameter. This method is similar to GetIndividualInformation, but is more efficient.
Note: although the contact information is labeled Business/Home, they are instead Primary/Billing respectively. As there is no Billing flag for phone/fax, this method will not populate data into these fields.
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:WEBIndividualGet>
<ns:key>207d1a31-567e-4a97-ac21-a1923a092755</ns:key>
</ns:WEBIndividualGet>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<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>
<WEBIndividualGetResponse xmlns="http://www.avectra.com/2005/">
<WEBIndividualGetResult>
[[IndividualType]]
</WEBIndividualGetResult>
</WEBIndividualGetResponse>
</soap:Body>
</soap:Envelope>
JSON Method
Get extended information about a customer.
GET /xweb/JSON/WEBIndividualGet?key=3ebe2b51-7f16-4ada-af2e-401425a45a24
POST /xweb/JSON/WEBIndividualGet
Copy
DATA: JSON
{
"WEBIndividualGet": {
"key": "3ebe2b51-7f16-4ada-af2e-401425a45a24"
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Individual": {
"CurrentKey": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"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",
"ind_cst_main_office_cst_key": "66126d5e-44f9-4663-8ce7-f0b26bf4fc52"
},
"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": "2019-12-13T16:41:00-06:00",
"cst_change_user": "netForumAdminUser",
"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_score_trend": "0",
"cst_exclude_from_social_flag": "0",
"cst_credit_available": "0.00",
"cst_receives_member_benefits_flag": "1",
"cst__ind_send_mail_reset_flag": "0"
},
"Organization_XRef": {
"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"
},
"Organization": {
"org_cst_key": "66126d5e-44f9-4663-8ce7-f0b26bf4fc52",
"org_name": "Medical University of South Carolina",
"org_ogt_code": "University",
"org_cst_key_ext": "66126d5e-44f9-4663-8ce7-f0b26bf4fc52",
"org_ind_cst_key": "fa037b84-5a49-4f84-933f-9454d7fcf6f5",
"org_add_date": "2009-03-02T19:16:00-06:00",
"org_nonprofit_flag": "0",
"org_add_user": "Conversion",
"org_change_date": "2013-01-28T12:35:17-06:00",
"org_number_staff_purchasing_ext": "6) 16-38",
"org_change_user": "LErb",
"org_fiscal_year_ext": "July",
"org_delete_flag": "0",
"org_population_served_ext": "1000000",
"org_purchasing_volume_ext": "300000000.00"
},
"Email": {
"eml_key": "46538194-e963-4ffa-8c99-571e79594015",
"eml_address": "LizaGrimshaw3@otitest.com",
"eml_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"eml_type": "business",
"eml_add_user": "user",
"eml_add_date": "2018-07-25T12:04:20-05:00",
"eml_delete_flag": "0",
"eml_key_ext": "46538194-e963-4ffa-8c99-571e79594015",
"eml_invalid_flag": "0",
"eml_unlisted_flag": "0"
},
"Website": {
"url_type": "internet",
"url_primary": "0"
},
"Messaging": {
"msg_primary": "0"
},
"Business_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"
},
"Business_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",
"adr_geography": "Null"
},
"Business_Address_State": {
"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"
},
"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_key": "de5f4824-b2cd-4ada-8334-03fde63894c3",
"cph_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cph_phn_key": "9c1f95de-f570-4130-a037-290a2fa44c10",
"cph_pht_key": "88ff5661-2d14-4bdf-be4c-906c3bff7ef7",
"cph_add_user": "web:test@otitest.com",
"cph_add_date": "2013-02-18T10:40:17-06:00",
"cph_change_user": "user",
"cph_change_date": "2018-07-25T12:06:03-05:00",
"cph_delete_flag": "0",
"cph_key_ext": "de5f4824-b2cd-4ada-8334-03fde63894c3",
"cph_unlisted_flag": "0",
"cph_phn_number_complete": "843-792-8148"
},
"Business_Phone": {
"phn_key": "9c1f95de-f570-4130-a037-290a2fa44c10",
"phn_cst_key_owner": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"phn_number": "843-792-8148",
"phn_number_display": "843-792-8148",
"phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183",
"phn_add_user": "web:test@otitest.com",
"phn_add_date": "2013-02-18T10:40:17-06:00",
"phn_change_user": "user",
"phn_change_date": "2018-07-25T12:06:03-05:00",
"phn_delete_flag": "0",
"phn_key_ext": "9c1f95de-f570-4130-a037-290a2fa44c10"
},
"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": "0",
"cfx_owner": "0"
},
"Business_Fax": {
"fax_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Business_Fax_Country": null,
"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": null,
"Home_Phone": {
"ph2__phn_cty_key": "bc4b70f8-280e-4bb0-b935-9f728c50e183"
},
"Home_Phone_Country": null,
"Home_Phone_XRef": {
"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_fxt_key": "6b632577-c4ef-42ac-ae19-6dfe0ddece4b",
"cf2__cfx_primary": "0",
"cf2__cfx_owner": "0"
},
"Address_Change_Log": null,
"TransferToCustomer": null,
"Individual_Custom_Demographics": {
"idm_key": "efa21803-6a14-4cae-b783-aa292ba69401",
"idm_add_user": "user",
"idm_add_date": "2016-10-04T00:00:00-05:00",
"idm_delete_flag": "0",
"idm_custom_flag_01": "0",
"idm_custom_flag_02": "0",
"idm_custom_flag_03": "0",
"idm_custom_flag_04": "0",
"idm_custom_flag_05": "0",
"idm_custom_flag_06": "0",
"idm_custom_flag_07": "0",
"idm_custom_flag_08": "0",
"idm_custom_flag_09": "0",
"idm_custom_flag_10": "0",
"idm_custom_flag_11": "0",
"idm_custom_flag_12": "0",
"idm_custom_flag_13": "0",
"idm_custom_flag_14": "0",
"idm_custom_flag_15": "0",
"idm_key_ext": "efa21803-6a14-4cae-b783-aa292ba69401",
"idm_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24"
},
"Social_Links": {
"cel_cst_key": "3ebe2b51-7f16-4ada-af2e-401425a45a24",
"cel_add_user": "user",
"cel_add_date": "2016-10-04T00:00:00-05:00",
"cel_delete_flag": "0",
"cel_cst_key_ext": "3ebe2b51-7f16-4ada-af2e-401425a45a24"
},
"source_code": null
}
}
JSON Method: WEBIndividualGetGenders
POST /xWeb/JSON/WEBIndividualGetGenders
Copy
DATA: JSON
{
"WEBIndividualGetGenders": null
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "7",
"Result": [
{
"gen_key": "b775cc4f-68eb-4522-954a-dea9c133ef61",
"gen_code": "Female"
},
{
"gen_key": "90cebc8c-943d-42e2-9067-5932920aaf71",
"gen_code": "Male"
},
{
"gen_key": "7ce7bfb4-cbc5-4683-8458-93972ceea61b",
"gen_code": "newGender"
},
{
"gen_key": "3e3752fb-ada2-4453-a950-a10792abedf4",
"gen_code": "pqr"
},
{
"gen_key": "a92dc276-05c7-4db1-b298-ca5fdf8fe486",
"gen_code": "Test12"
},
{
"gen_key": "c9779cd0-39a2-4f4f-b51d-1465e578a7d8",
"gen_code": "Test12345"
},
{
"gen_key": "ac719281-33a7-4ca7-a14b-c8eeee6721a2",
"gen_code": "xyz"
}
]
}
}
JSON Method: WEBIndividualGetPronouns
POST /xWeb/JSON/WEBIndividualGetPronouns
Copy
DATA: JSON
{
"WEBIndividualGetPronouns": null
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"Results": {
"@recordReturn": "5",
"Result": [
{
"prn_key": "1cbb5b2e-930f-4a2b-b4ea-773e7a9c9ade",
"prn_code": null
},
{
"prn_key": "102993ba-a486-492a-81a2-5ad3724265d1",
"prn_code": "he/him/his"
},
{
"prn_key": "29213eb0-b02e-47d5-8252-91071d87291c",
"prn_code": "me/myself"
},
{
"prn_key": "1897c6d9-bb59-4634-80b6-c74a98106a38",
"prn_code": "she/her/hers"
},
{
"prn_key": "2a6e3801-3d7a-40a9-8143-1f7dea52bff7",
"prn_code": "they/them/theirs"
}
]
}
}