List Membership History

Use this method to retrieve the membership history for a given constituent account.

REST

Request

https://api.neoncrm.com/neonws/services/api/membership/listMembershipHistory?userSessionId=T1361084631046&accountId=123958

Response

{
    "listMembershipHistoryResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "12 records found.",
        "responseDateTime": "2013-02-17T19:37:39.889-06:00",
        "membershipResults": {
            "membershipResult": [
                {
                    "accountId": 123958,
                    "membershipTerm": {
                        "termInfo": {
                            "id": 505,
                            "name": "320 individual group 1"
                        },
                        "isParentTerm": true
                    },
                    "source": {
                        "id": 51,
                        "name": "Your Custom Selection"
                    },
                    "customFieldDataList": "",
                    "membershipId": 134,
                    "membershipName": "320 individual group 1",
                    "termDuration": "1YEAR",
                    "fee": 360,
                    "transactionDate": "2013-02-17T00:00:00.000-06:00",
                    "termStartDate": "2023-09-01-05:00",
                    "termEndDate": "2024-08-31-05:00",
                    "enrollmentType": "JOIN",
                    "status": "Succeed"
                },
                ...
            ]
        }
    }
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:listmembershiphistoryrequest>
             <usersessionid>T1360999972510</usersessionid>
            <accountid>3299</accountid>
          </neon:listmembershiphistoryrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:body>
        <ns2:listmembershiphistoryresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
            <operationresult>SUCCESS</operationresult>
            <responsemessage>12 records found.</responsemessage>
            <responsedatetime>2013-02-17T19:42:46.433-06:00</responsedatetime>
            <membershipresults>
                <membershipresult>
                   <accountid>123958</accountid>
                   <membershipterm>
                      <terminfo>
                         <id>505</id>
                         <name>320 individual group 1</name>
                      </terminfo>
                      <isparentterm>true</isparentterm>
                   </membershipterm>
                   <source>
                      <id>51</id>
                      <name>Your Custom Selection</name>
                    </source>
                   <customfielddatalist>
                       <membershipid>134</membershipid>
                       <membershipname>320 individual group 1</membershipname>
                       <termduration>1YEAR</termduration>
                       <fee>360.0</fee>
                       <transactiondate>2013-02-17T00:00:00.000-06:00</transactiondate>
                       <termstartdate>2023-09-01-05:00</termstartdate>
                       <termenddate>2024-08-31-05:00</termenddate>
                       <enrollmenttype>JOIN</enrollmenttype>
                       <status>Succeed</status>
                    </customfielddatalist>
                </membershipresult>
            </membershipresults>
        </ns2:listmembershiphistoryresponse>
    </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
accountId Yes The account for which you would like to retrieve membership history.

Response Parameters

Name Required Description
membership.accountId Yes
membership.membershipTerm.termInfo.id Yes
membership.membershipTerm.termInfo.name Yes
membership.autoRenewal
membership.source.id
membership.source.name
membership.customFieldDataList.customFieldData.fieldId
membership.customFieldDataList.customFieldData.fieldName
membership.customFieldDataList.customFieldData.fieldOptionId
membership.membershipId Yes
membership.membershipName Yes
membership.termDuration Yes
membership.fee
membership.transactionDate Format: 2013-02-17T00:00:00.000-06:00
membership.termStartDate Format: 2020-09-01-05:00
membership.termEndDate Format: 2020-09-01-05:00
membership.enrollmentType Possible values: JOIN, RENEW
membership.status Status of the payments related to this membership

Error Codes

Code Text Description
10131 Account id is required.
10132 Account id is invalid.