WEBChaptersGetChapterMembershipRoster

Initial Build	2008.01
xWeb	Web Method
Response Type	XML results

This method returns a list of members for a specific chapter as identified by the ChapterKey parameter provided.

Parameters

Name	Type	Occurs	Description
ChapterKey	guid	1..1	Key of the chapter for which the list of members is being requested.

Response

XML Results

A list of the members of the chapter including their name, email, organization, member type, status, join date, effective date, expire date, and if the person is an Active member.

Name	Description	Datatype	Notes
mbr_key	Member Key	string (in guid format)	Primary Key of the chapter membership.
cst_key	Customer Key	string (in guid format)	Customer Key
cst_type	Customer Type	string	Will be Individual or Organization.
Active	Active	string	yes or no.
ind_first_name	First Name	string
ind_last_name	Last Name	string
cst_sort_name_dn	Sort Name	string	Sort Name
cst_eml_address_dn	Email Address	string
cst_org_name_dn	Organization Name	string	Typically the name of an individual's primary organization.
mbt_code	Member Type Code	string	Member Type
mbs_code	Member Status Code	string	Member Status
mbr_join_date	Join Date	string (in MM/DD/YYYY format)
mbr_rejoin_date	Rejoin Date	string (in MM/DD/YYYY format)
mbr_renew_date	Renew Date	string (in MM/DD/YYYY format)
mbr_expire_date	Expire Date	string (in MM/DD/YYYY format)
mbr_terminate_date	Terminate Date	string (in MM/DD/YYYY format)

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>*******************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBChaptersGetChapterMembershipRoster>
<ns:ChapterKey>b747933c-602c-472b-bc92-e6b096d878bd</ns:ChapterKey>
</ns:WEBChaptersGetChapterMembershipRoster>
</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>dd6169fc-76ab-4811-8efc-5fbba9a9683f</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBChaptersGetChapterMembershipRosterResponse xmlns="http://www.avectra.com/2005/">
<WEBChaptersGetChapterMembershipRosterResult>
<Results recordReturn="3">
<Result>
<mbr_key>5432421f-9cdc-455b-96f3-6d036bc8257d</mbr_key>
<cst_key>81341098-7d45-4ef3-b663-3a2a79e149cb</cst_key>
<cst_type>Individual</cst_type>
<Active>yes</Active>
<ind_first_name>A Guy</ind_first_name>
<ind_last_name>~ guy</ind_last_name>
<cst_sort_name_dn>~ guy A Guy</cst_sort_name_dn>
<cst_eml_address_dn>[e-mail]</cst_eml_address_dn>
<cst_org_name_dn>128 org</cst_org_name_dn>
<mbt_code>AV_Chpt</mbt_code>
<mbs_code/>
<mbr_join_date/>
<mbr_rejoin_date/>
<mbr_renew_date/>
<mbr_expire_date/>
<mbr_terminate_date>12/13/2011</mbr_terminate_date>
</Result>
<Result>
<mbr_key>eed83b27-402f-4002-8e68-fa8d998c1d56</mbr_key>
<cst_key>f509771c-7f8c-44dc-be67-47c3207afdc2</cst_key>
<cst_type>Individual</cst_type>
<Active>yes</Active>
<ind_first_name>Asia</ind_first_name>
<ind_last_name>Active</ind_last_name>
<cst_sort_name_dn>Active Asia</cst_sort_name_dn>
<cst_eml_address_dn/>
<cst_org_name_dn/>
<mbt_code>AV_Chpt</mbt_code>
<mbs_code>Dropped</mbs_code>
<mbr_join_date>10/28/2011</mbr_join_date>
<mbr_rejoin_date/>
<mbr_renew_date>10/01/2011</mbr_renew_date>
<mbr_expire_date>09/30/2012</mbr_expire_date>
<mbr_terminate_date>11/10/2011</mbr_terminate_date>
</Result>
<Result>
<mbr_key>21044a97-b583-4024-b08b-20472429e5df</mbr_key>
<cst_key>1911a09e-e8dc-49c3-9801-9144b84a99be</cst_key>
<cst_type>Individual</cst_type>
<Active>yes</Active>
<ind_first_name>Asia</ind_first_name>
<ind_last_name>B4263</ind_last_name>
<cst_sort_name_dn>B4263 Asia</cst_sort_name_dn>
<cst_eml_address_dn/>
<cst_org_name_dn/>
<mbt_code>AVChpt_100% of 1st Payment Due</mbt_code>
<mbs_code/>
<mbr_join_date>01/03/2012</mbr_join_date>
<mbr_rejoin_date/>
<mbr_renew_date>10/03/2011</mbr_renew_date>
<mbr_expire_date>10/02/2012</mbr_expire_date>
<mbr_terminate_date/>
</Result>
</Results>
</WEBChaptersGetChapterMembershipRosterResult>
</WEBChaptersGetChapterMembershipRosterResponse>
</soap:Body>
</soap:Envelope>

JSON Method

POST /xWeb/JSON/WEBChaptersGetChapterMembershipRoster

DATA: JSON
{
    "WEBChaptersGetChapterMembershipRoster": {
        "ChapterKey": "{{chpCstKeyChapterWithMembers}}"
    }
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "2",
        "Result": [
            {
                "mbr_key": "3966dd0c-1957-4688-b9e7-638c4c1e894a",
                "cst_key": "23ce4daf-9a3c-4248-8971-11520ee9ec0b",
                "cst_type": "Organization",
                "Active": "no",
                "ind_first_name": null,
                "ind_last_name": null,
                "cst_sort_name_dn": "INTACCT Company",
                "cst_eml_address_dn": null,
                "cst_org_name_dn": "INTACCT Company",
                "mbt_code": "DELL CHAPTER2 Member Type (calendar)",
                "mbs_code": null,
                "mbr_join_date": "10/23/2020",
                "mbr_rejoin_date": null,
                "mbr_renew_date": "01/01/2020",
                "mbr_expire_date": "12/31/2020",
                "mbr_terminate_date": null
            },
            {
                "mbr_key": "dfe8aa50-8187-4c4b-a781-006759e27340",
                "cst_key": "b33e0ff2-1edf-44f6-a6a6-fbd82813b8eb",
                "cst_type": "Organization",
                "Active": "no",
                "ind_first_name": null,
                "ind_last_name": null,
                "cst_sort_name_dn": "INTACCT Warehouse",
                "cst_eml_address_dn": null,
                "cst_org_name_dn": "INTACCT Warehouse",
                "mbt_code": "DELL CHAPTER2 Member Type (calendar)",
                "mbs_code": null,
                "mbr_join_date": "10/23/2020",
                "mbr_rejoin_date": null,
                "mbr_renew_date": "01/01/2020",
                "mbr_expire_date": "12/31/2020",
                "mbr_terminate_date": null
            }
        ]
    }
}

Related Functionality

Chapter Member

Recommendations

The members of a chapter and their related information typically does not change moment by moment. 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, rather than getting a real-time result on every page visit.