WEBActivityGetPurchasedChapterMembershipsByCustomer

Initial Build	n/a
xWeb	Web Method
Response Type	XML Results

The WEBActivityGetPurchasedChapterMembershipsByCustomer web method returns a list of any Chapter Memberships for the specified customer. These could be active or terminated.

Parameters

The request contains the following parameter:

Name	Type	Occurs	Description
CustomerKey	guid	1..1	The primary key for the customer.

Response

XML Results

Name	Description	Datatype	Notes
mbr_key	Membership Key	string (in guid format)	The primary key of the Membership. This value often is needed as a parameter in other web methods.
mbr_chp_cst_key	Chapter Customer Key	string (in guid format)	The Customer Key of the Chapter. In netFORUM, a Chapter is itself a customer.
_order	Order	integer	An internal use ordering number that can be ignored.
_mbr_through	Member Through Indicator	string	Will either be Self if the customer acquired the membership on their own, or it will be the name of the customer from whom the membership was inherited. For example, if an employee of an organization gets member benefits from that employee relationship, then the value of _mbr_through will be the name of the organization.
Chapter	Chapter	string	The name of the Chapter.
MbrType	Member Type	string	The Member Type of the chapter membership.
MbrStatus	Member Status	string	The Member Status (if any) of the chapter membership.
MbrThrough	Member Through	string	Same as _mbr_through.
Join	Join Date	string in MM/DD/YYYY format	Date Joined
Effective	Effective Date	string in MM/DD/YYYY format
Expire	Expire Date	string in MM/DD/YYYY format
Terminate	Terminate Date	string in MM/DD/YYYY format
RelatedMembership	Related Membership	string	Member Type code of the "parent" membership, if any.

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:WEBActivityGetPurchasedChapterMembershipsByCustomer>
<ns:CustomerKey>dd599eae-5232-4495-8e50-e45750030753</ns:CustomerKey>
</ns:WEBActivityGetPurchasedChapterMembershipsByCustomer>
</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>bb9c4c09-d91b-4de3-8056-155c4006ce3d</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBActivityGetPurchasedChapterMembershipsByCustomerResponse xmlns="http://www.avectra.com/2005/">
<WEBActivityGetPurchasedChapterMembershipsByCustomerResult>
<Results recordReturn="1">
<Result>
<mbr_key>25217879-23d0-4fa0-b3cc-f1831c03ad2c</mbr_key>
<mbr_chp_cst_key>6279e76d-edc1-45da-85ec-883c03d94543</mbr_chp_cst_key>
<_order>0</_order>
<_mbr_through>Self</_mbr_through>
<Chapter>Al Test Chapter</Chapter>
<MbrType>Virginia Chapter</MbrType>
<MbrStatus/>
<MbrThrough>Self</MbrThrough>
<Join>04/06/2011</Join>
<Effective>04/01/2011</Effective>
<Expire>03/31/2012</Expire>
<Terminate/>
<RelatedMembership/>
</Result>
<Result>
<mbr_key>85cb8393-bbfc-451f-bc53-f3df4c4bf432</mbr_key>
<mbr_chp_cst_key>98fc3c29-c1b3-43ae-ad03-aa7b1fa83375</mbr_chp_cst_key>
<_order>0</_order>
<_mbr_through>Self</_mbr_through>
<Chapter>Virginia Chapter</Chapter>
<MbrType>Virginia Chapter</MbrType>
<MbrStatus/>
<MbrThrough>Self</MbrThrough>
<Join/>
<Effective/>
<Expire/>
<Terminate>04/13/2011</Terminate>
<RelatedMembership>Regular</RelatedMembership>
</Result>
</Results>
</WEBActivityGetPurchasedChapterMembershipsByCustomerResult>
</WEBActivityGetPurchasedChapterMembershipsByCustomerResponse>
</soap:Body>
</soap:Envelope>

 

JSON Method

POST /xWeb/JSON/WEBActivityGetPurchasedChapterMembershipsByCustomer

DATA: JSON
{
    "WEBActivityGetPurchasedChapterMembershipsByCustomer": {
        "CustomerKey":"{{indCstKeyChaperMembershipPurchaseA}}"
    }
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
    "Results": {
        "@recordReturn": "1",
        "Result": [
            {
                "mbr_key": "7e782fae-a960-4a3d-bace-066515d0ff5e",
                "mbr_chp_cst_key": "347a8c0f-38cd-46a7-915c-e08767b158c1",
                "_order": "0",
                "_mbr_through": "Self",
                "Chapter": "Bell Chapter1",
                "MbrType": "Bell CHAPTER Member Type (calendar)",
                "MbrStatus": null,
                "MbrThrough": "Self",
                "Join": "10/27/2021",
                "Effective": "01/01/2021",
                "Expire": "12/31/2021",
                "Terminate": null,
                "RelatedMembership": null
            }
        ]
    }
}