List Membership Terms

This request lists all of the membership terms that have been configured in your Membership System Settings. You’ll need to know the ID of a membership term in order to create a membership record for an account.

REST

Request

https://api.neoncrm.com/neonws/services/api/membership/listMembershipTerms?userSessionId=T1361084631046

Response

{
    "listMembershipTermsResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "1 records found.",
        "responseDateTime": "2013-02-17T15:34:46.501+08:00",
        "membershipTerms": {
            "membershipTerm": {
                "termInfo": {
                    "id": 505,
                    "name": "320 individual group 1"
                },
                "isParentTerm": true,
                "childTerms": {
                    "idNamePair": [
                        {
                            "id": 507,
                            "name": "320 individual group 1 child"
                        },
                        {
                            "id": 508,
                            "name": "320 individual group 1 child"
                        }
                    ]
                }
            }
        }
    }
}

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:listmembershiptermsrequest>
                <usersessionid>T1361071210552</usersessionid>
                <termid>505</termid>
                <termName> individual </termName>
            </neon:listmembershiptermsrequest>
        </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listmembershiptermsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>1 records found.</responsemessage>
         <responsedatetime>2013-02-17T11:37:32.417-06:00</responsedatetime>
         <membershipterms>
            <membershipterm>
               <terminfo>
                  <id>505</id>
                  <name>320 individual group 1</name>
               </terminfo>
               <isparentterm>true</isparentterm>
               <childterms>
                  <idnamepair>
                     <id>507</id>
                     <name>320 individual group 1 child</name>
                  </idnamepair>
                  <idnamepair>
                     <id>508</id>
                     <name>320 individual group 1 child</name>
                  </idnamepair>
               </childterms>
            </membershipterm>
         </membershipterms>
      </ns2:listmembershiptermsresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
termId Retrieve a specific membership term by specifying its ID.
termName Retrieve a specific membership term by specifying its name.

Response Parameters

Name Required Description
membershipTerm.termInfo.id A membership term’s ID.
membershipTerm.termInfo.name A membership term’s name.
membershipTerm.isParentTerm Whether this membership term has child membership terms associated with it. Possible values: true, false
membershipTerm.childTerms.idNamePair.id A child membership term’s ID.
membershipTerm.childTerms.idNamePair.name A child membership term’s name.