List Purposes

This request returns a list of all purposes, with their associated IDs.

REST

Request

https://api.neoncrm.com/neonws/services/api/donation/listPurposes?userSessionId=[session id]

Response

{
    "listPurposes": {
        "operationResult": "SUCCESS",
        "responseMessage": "3 records was found.",
        "responseDateTime": "2013-02-21T03:48:49.291-06:00",
        "purposes": {
            "purpose": [
                {
                    "id": 26,
                    "name": "Building 2"
                },
                {
                    "id": 21,
                    "name": "Building1"
                },
                {
                    "id": 19,
                    "name": "Construction"
                }
              ]
        }
    }
}

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:listpurposesrequest>
             <usersessionid>T1361758244044</usersessionid>
         </neon:listpurposesrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listpurposesresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>11 records was found.</responsemessage>
         <responsedatetime>2013-02-24T20:12:27.277-06:00</responsedatetime>
         <purposes>
            <purpose>
               <id>26</id>
               <name>Building 2</name>
            </purpose>
            <purpose>
               <id>21</id>
               <name>Building1</name>
            </purpose>
            <purpose>
               <id>19</id>
               <name>Construction</name>
            </purpose>
          </purposes>
      </ns2:listpurposesresponse>
   </soap:body>
</soap:envelope>

Response Parameters

Name	Required	Description
purpose.id	Yes	Purpose ID
purpose.name	Yes	Purpose Name