WEBCommitteeGetCommitteeByKey

Initial Build

2008.01

xWEB

Web Method

Response Type

XML results

This method can be used to get committee information using a committee key.

Parameters

The request contains the following required parameter:

Name Type Occurs Description
CommitteeKey guid 1..1 The key of the committee being requested.

Response

XML Results

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>2e7ad5c9-52f6-450f-9459-3fabb985bf67</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCommitteeGetCommitteeByKey>
<ns:CommitteeKey>3f1fa2e9-01e6-4ff6-b5b6-1fe3b2b73c58</ns:CommitteeKey>
</ns:WEBCommitteeGetCommitteeByKey>
</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>2e7ad5c9-52f6-450f-9459-3fabb985bf67</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCommitteeGetCommitteeByKeyResponse xmlns="http://www.avectra.com/2005/">
<WEBCommitteeGetCommitteeByKeyResult>
<CommitteeObjects xsi:schemaLocation="http://www.avectra.com/2005/ Committee.xsd" recordReturn="1">
<CommitteeObject>
<cmt_key>3f1fa2e9-01e6-4ff6-b5b6-1fe3b2b73c58</cmt_key>
<cmt_asn_code>SDAsso1</cmt_asn_code>
<cmt_code>SD Code</cmt_code>
<cmt_ctp_code>Food</cmt_ctp_code>
<cmt_name>SD Sub Committee</cmt_name>
<cmt_begin_date xsi:nil="true"/>
<cmt_end_date xsi:nil="true"/>
<cmt_add_date>2008-08-25</cmt_add_date>
<cmt_add_user>sdani</cmt_add_user>
<cmt_change_date xsi:nil="true"/>
<cmt_change_user xsi:nil="true"/>
<cmt_delete_flag>0</cmt_delete_flag>
<cmt_key_ext xsi:nil="true"/>
<cmt_entity_key xsi:nil="true"/>
<cmt_parent_key>bcaeaa77-84eb-4973-be39-563c6fa3d018</cmt_parent_key>
<cmt_description xsi:nil="true"/>
<cmt_html_description xsi:nil="true"/>
<cmt_region xsi:nil="true"/>
<cmt_cst_key xsi:nil="true"/>
<cmp__cmt_key>bcaeaa77-84eb-4973-be39-563c6fa3d018</cmp__cmt_key>
<cmp__cmt_asn_code>AV</cmp__cmt_asn_code>
<cmp__cmt_code>BoD</cmp__cmt_code>
<cmp__cmt_ctp_code>Standing</cmp__cmt_ctp_code>
<cmp__cmt_name>Board of Directors</cmp__cmt_name>
<cmp__cmt_begin_date xsi:nil="true"/>
<cmp__cmt_end_date xsi:nil="true"/>
<cmp__cmt_add_date>2008-08-25</cmp__cmt_add_date>
<cmp__cmt_add_user>sdani</cmp__cmt_add_user>
<cmp__cmt_change_date xsi:nil="true"/>
<cmp__cmt_change_user xsi:nil="true"/>
<cmp__cmt_delete_flag>0</cmp__cmt_delete_flag>
<cmp__cmt_key_ext>bcaeaa77-84eb-4973-be39-563c6fa3d018</cmp__cmt_key_ext>
<cmp__cmt_entity_key xsi:nil="true"/>
<cmp__cmt_parent_key>64233ffa-9f57-4d38-b21b-2cc108fbdaaa</cmp__cmt_parent_key>
<cmp__cmt_description xsi:nil="true"/>
<cmp__cmt_html_description xsi:nil="true"/>
<cmp__cmt_region xsi:nil="true"/>
<cmp__cmt_cst_key>0db5525f-246f-4380-85b0-c9f01b75141a</cmp__cmt_cst_key>
<cst_key xsi:nil="true"/>
<cst_type xsi:nil="true"/>
<cst_name_cp xsi:nil="true"/>
<cst_sort_name_dn xsi:nil="true"/>
<cst_ind_full_name_dn xsi:nil="true"/>
<cst_org_name_dn xsi:nil="true"/>
<cst_ixo_title_dn xsi:nil="true"/>
<cst_pref_comm_meth xsi:nil="true"/>
<cst_bio xsi:nil="true"/>
<cst_add_date xsi:nil="true"/>
<cst_add_user xsi:nil="true"/>
<cst_change_date xsi:nil="true"/>
<cst_change_user xsi:nil="true"/>
<cst_delete_flag xsi:nil="true"/>
<cst_recno xsi:nil="true"/>
<cst_id xsi:nil="true"/>
<cst_email_text_only xsi:nil="true"/>
<cst_credit_limit xsi:nil="true"/>
<cst_src_code xsi:nil="true"/>
<cst_tax_exempt_flag xsi:nil="true"/>
<cst_tax_id xsi:nil="true"/>
<cst_no_email_flag xsi:nil="true"/>
<cst_cxa_key xsi:nil="true"/>
<cst_cxa_billing_key xsi:nil="true"/>
<cst_eml_address_dn xsi:nil="true"/>
<cst_eml_key xsi:nil="true"/>
<cst_no_phone_flag xsi:nil="true"/>
<cst_phn_number_complete_dn xsi:nil="true"/>
<cst_cph_key xsi:nil="true"/>
<cst_no_fax_flag xsi:nil="true"/>
<cst_fax_number_complete_dn xsi:nil="true"/>
<cst_cfx_key xsi:nil="true"/>
<cst_ixo_key xsi:nil="true"/>
<cst_oldid xsi:nil="true"/>
<cst_no_web_flag xsi:nil="true"/>
<cst_url_code_dn xsi:nil="true"/>
<cst_member_flag xsi:nil="true"/>
<cst_url_key xsi:nil="true"/>
<cst_parent_cst_key xsi:nil="true"/>
<cst_no_msg_flag xsi:nil="true"/>
<cst_msg_handle_dn xsi:nil="true"/>
<cst_web_login xsi:nil="true"/>
<cst_web_password xsi:nil="true"/>
<cst_msg_key xsi:nil="true"/>
<cst_entity_key xsi:nil="true"/>
<cst_web_start_date xsi:nil="true"/>
<cst_no_mail_flag xsi:nil="true"/>
<cst_web_end_date xsi:nil="true"/>
<cst_web_force_password_change xsi:nil="true"/>
<cst_web_login_disabled_flag xsi:nil="true"/>
<cst_comment xsi:nil="true"/>
<cst_credit_hold_flag xsi:nil="true"/>
<cst_credit_hold_reason xsi:nil="true"/>
<cst_web_forgot_password_status xsi:nil="true"/>
<cst_old_cxa_key xsi:nil="true"/>
<cst_last_email_date xsi:nil="true"/>
<cst_no_publish_flag xsi:nil="true"/>
<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"/>
</CommitteeObject>
</CommitteeObjects>
</WEBCommitteeGetCommitteeByKeyResult>
</WEBCommitteeGetCommitteeByKeyResponse>
</soap:Body>
</soap:Envelope>
   

JSON Method

POST /xWeb/JSON/WEBCommitteeGetCommitteeByKey

Copy
DATA: JSON
{
    "WEBCommitteeGetCommitteeByKey": {
        "CommitteeKey": "{{cmtKeyActiveCommittee}}"
    }
}

 

Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "CommitteeObjects": {
        "@schemaLocation": "http://www.avectra.com/2005/ Committee.xsd",
        "@recordReturn": "1",
        "CommitteeObject": [
            {
                "cmt_key": "733f41ba-fe04-4449-b74e-0027850a0d08",
                "cmt_asn_code": "NALi3yil",
                "cmt_code": "Cod0CFOXK",
                "cmt_ctp_code": "Committee TypeXvM9tF",
                "cmt_name": "CommitteeNameCustom0CFOXK",
                "cmt_begin_date": "2021-07-09T00:00:00+12:00",
                "cmt_end_date": "2022-07-09T00:00:00+12:00",
                "cmt_add_date": "2021-07-09T23:43:00+12:00",
                "cmt_add_user": "netforumapp",
                "cmt_change_date": {
                    "@nil": "true"
                },
                "cmt_change_user": {
                    "@nil": "true"
                },
                "cmt_delete_flag": "0",
                "cmt_key_ext": "733f41ba-fe04-4449-b74e-0027850a0d08",
                "cmt_entity_key": {
                    "@nil": "true"
                },
                "cmt_parent_key": {
                    "@nil": "true"
                },
                "cmt_description": "CommitteeDesc0CFOXK",
                "cmt_html_description": {
                    "@nil": "true"
                },
                "cmt_region": {
                    "@nil": "true"
                },
                "cmt_cst_key": {
                    "@nil": "true"
                },
                "cmp__cmt_key": {
                    "@nil": "true"
                },
                "cmp__cmt_asn_code": {
                    "@nil": "true"
                },
                "cmp__cmt_code": {
                    "@nil": "true"
                },
                "cmp__cmt_ctp_code": {
                    "@nil": "true"
                },
                "cmp__cmt_name": {
                    "@nil": "true"
                },
                "cmp__cmt_begin_date": {
                    "@nil": "true"
                },
                "cmp__cmt_end_date": {
                    "@nil": "true"
                },
                "cmp__cmt_add_date": {
                    "@nil": "true"
                },
                "cmp__cmt_add_user": {
                    "@nil": "true"
                },
                "cmp__cmt_change_date": {
                    "@nil": "true"
                },
                "cmp__cmt_change_user": {
                    "@nil": "true"
                },
                "cmp__cmt_delete_flag": {
                    "@nil": "true"
                },
                "cmp__cmt_key_ext": {
                    "@nil": "true"
                },
                "cmp__cmt_entity_key": {
                    "@nil": "true"
                },
                "cmp__cmt_parent_key": {
                    "@nil": "true"
                },
                "cmp__cmt_description": {
                    "@nil": "true"
                },
                "cmp__cmt_html_description": {
                    "@nil": "true"
                },
                "cmp__cmt_region": {
                    "@nil": "true"
                },
                "cmp__cmt_cst_key": {
                    "@nil": "true"
                },
                "cst_key": {
                    "@nil": "true"
                },
                "cst_type": {
                    "@nil": "true"
                },
                "cst_name_cp": {
                    "@nil": "true"
                },
                "cst_sort_name_dn": {
                    "@nil": "true"
                },
                "cst_ind_full_name_dn": {
                    "@nil": "true"
                },
                "cst_org_name_dn": {
                    "@nil": "true"
                },
                "cst_ixo_title_dn": {
                    "@nil": "true"
                },
                "cst_pref_comm_meth": {
                    "@nil": "true"
                },
                "cst_bio": {
                    "@nil": "true"
                },
                "cst_add_date": {
                    "@nil": "true"
                },
                "cst_add_user": {
                    "@nil": "true"
                },
                "cst_change_date": {
                    "@nil": "true"
                },
                "cst_change_user": {
                    "@nil": "true"
                },
                "cst_delete_flag": {
                    "@nil": "true"
                },
                "cst_recno": {
                    "@nil": "true"
                },
                "cst_id": {
                    "@nil": "true"
                },
                "cst_key_ext": {
                    "@nil": "true"
                },
                "cst_email_text_only": {
                    "@nil": "true"
                },
                "cst_credit_limit": {
                    "@nil": "true"
                },
                "cst_src_key": {
                    "@nil": "true"
                },
                "cst_src_code": {
                    "@nil": "true"
                },
                "cst_tax_exempt_flag": {
                    "@nil": "true"
                },
                "cst_tax_id": {
                    "@nil": "true"
                },
                "cst_cxa_key": {
                    "@nil": "true"
                },
                "cst_no_email_flag": {
                    "@nil": "true"
                },
                "cst_cxa_billing_key": {
                    "@nil": "true"
                },
                "cst_eml_address_dn": {
                    "@nil": "true"
                },
                "cst_eml_key": {
                    "@nil": "true"
                },
                "cst_no_phone_flag": {
                    "@nil": "true"
                },
                "cst_phn_number_complete_dn": {
                    "@nil": "true"
                },
                "cst_cph_key": {
                    "@nil": "true"
                },
                "cst_no_fax_flag": {
                    "@nil": "true"
                },
                "cst_fax_number_complete_dn": {
                    "@nil": "true"
                },
                "cst_cfx_key": {
                    "@nil": "true"
                },
                "cst_ixo_key": {
                    "@nil": "true"
                },
                "cst_no_web_flag": {
                    "@nil": "true"
                },
                "cst_oldid": {
                    "@nil": "true"
                },
                "cst_member_flag": {
                    "@nil": "true"
                },
                "cst_url_code_dn": {
                    "@nil": "true"
                },
                "cst_parent_cst_key": {
                    "@nil": "true"
                },
                "cst_url_key": {
                    "@nil": "true"
                },
                "cst_no_msg_flag": {
                    "@nil": "true"
                },
                "cst_msg_handle_dn": {
                    "@nil": "true"
                },
                "cst_web_login": {
                    "@nil": "true"
                },
                "cst_web_password": {
                    "@nil": "true"
                },
                "cst_entity_key": {
                    "@nil": "true"
                },
                "cst_msg_key": {
                    "@nil": "true"
                },
                "cst_no_mail_flag": {
                    "@nil": "true"
                },
                "cst_web_start_date": {
                    "@nil": "true"
                },
                "cst_web_end_date": {
                    "@nil": "true"
                },
                "cst_web_force_password_change": {
                    "@nil": "true"
                },
                "cst_web_login_disabled_flag": {
                    "@nil": "true"
                },
                "cst_comment": {
                    "@nil": "true"
                },
                "cst_credit_hold_flag": {
                    "@nil": "true"
                },
                "cst_credit_hold_reason": {
                    "@nil": "true"
                },
                "cst_web_forgot_password_status": {
                    "@nil": "true"
                },
                "cst_old_cxa_key": {
                    "@nil": "true"
                },
                "cst_last_email_date": {
                    "@nil": "true"
                },
                "cst_no_publish_flag": {
                    "@nil": "true"
                },
                "cst_sin_key": {
                    "@nil": "true"
                },
                "cst_ttl_key": {
                    "@nil": "true"
                },
                "cst_jfn_key": {
                    "@nil": "true"
                },
                "cst_cur_key": {
                    "@nil": "true"
                },
                "cst_attribute_1": {
                    "@nil": "true"
                },
                "cst_attribute_2": {
                    "@nil": "true"
                },
                "cst_salutation_1": {
                    "@nil": "true"
                },
                "cst_salutation_2": {
                    "@nil": "true"
                },
                "cst_merge_cst_key": {
                    "@nil": "true"
                },
                "cst_salutation_3": {
                    "@nil": "true"
                },
                "cst_salutation_4": {
                    "@nil": "true"
                },
                "cst_default_recognize_as": {
                    "@nil": "true"
                },
                "cst_score": {
                    "@nil": "true"
                },
                "cst_score_normalized": {
                    "@nil": "true"
                },
                "cst_score_trend": {
                    "@nil": "true"
                },
                "cst_vault_account": {
                    "@nil": "true"
                },
                "cst_exclude_from_social_flag": {
                    "@nil": "true"
                },
                "cst_social_score": {
                    "@nil": "true"
                },
                "cst_ptin": {
                    "@nil": "true"
                },
                "cst_aicpa_member_id": {
                    "@nil": "true"
                },
                "cst_vendor_code": {
                    "@nil": "true"
                },
                "cst_salt": {
                    "@nil": "true"
                },
                "cst_sca_key": {
                    "@nil": "true"
                },
                "cst_iterations": {
                    "@nil": "true"
                },
                "cst_web_password_change_date": {
                    "@nil": "true"
                },
                "cst_web_failed_login_count": {
                    "@nil": "true"
                },
                "cst_web_last_failed_login_date": {
                    "@nil": "true"
                },
                "cst_web_login_locked_flag": {
                    "@nil": "true"
                },
                "cmc_key": {
                    "@nil": "true"
                },
                "cmc_start_date": {
                    "@nil": "true"
                },
                "cmc_end_date": {
                    "@nil": "true"
                },
                "cmc_cst_key": {
                    "@nil": "true"
                },
                "cmc_add_date": {
                    "@nil": "true"
                },
                "cmc_add_user": {
                    "@nil": "true"
                },
                "cmc_change_date": {
                    "@nil": "true"
                },
                "cmc_change_user": {
                    "@nil": "true"
                },
                "cmc_delete_flag": {
                    "@nil": "true"
                },
                "cmc_key_ext": {
                    "@nil": "true"
                },
                "cmc_status": {
                    "@nil": "true"
                },
                "cmc_cmt_key": {
                    "@nil": "true"
                },
                "cmc_voting_flag": {
                    "@nil": "true"
                },
                "cmc_cxa_key": {
                    "@nil": "true"
                },
                "cmc_cph_key": {
                    "@nil": "true"
                },
                "cmc_eml_key": {
                    "@nil": "true"
                },
                "cmc_cfx_key": {
                    "@nil": "true"
                },
                "cmc_url_key": {
                    "@nil": "true"
                },
                "cmc_pref_comm_meth": {
                    "@nil": "true"
                },
                "cmc_rank": {
                    "@nil": "true"
                },
                "cmc_entity_key": {
                    "@nil": "true"
                },
                "cmc_funded_flag": {
                    "@nil": "true"
                },
                "cmc_status_date": {
                    "@nil": "true"
                },
                "cmc_cop_key": {
                    "@nil": "true"
                },
                "cmc_nom_key": {
                    "@nil": "true"
                },
                "cmc_renewable_flag": {
                    "@nil": "true"
                },
                "cmc_csu_key": {
                    "@nil": "true"
                }
            }
        ]
    }
}

 

 

Related Web Methods

WEBCommitteeGet is an improved version of this method that has a schema based on CommitteeType.

Recommendations

Information about Committees rarely changes. Therefore we recommend you cache these results and get a new list on a regular interval, especially in a high-traffic application that calls this method frequently.