API v1 Reference

List Campaigns

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

REST

Request

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

Response

{
    "listCampaigns": {
        "operationResult": "SUCCESS",
        "responseMessage": "2 records were found.",
        "responseDateTime": "2013-02-21T03:45:58.469-06:00",
        "campaigns": {
            "campaign": [
                {
                    "id": 249,
                    "name": "$5 Support a Kid"
                },
                {
                    "id": 276,
                    "name": 1234
                }
            ]
        }
    }
}

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

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listcampaignsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>2 records were found.</responsemessage>
         <responsedatetime>2013-02-24T19:56:12.617-06:00</responsedatetime>
         <campaigns>
            <campaign>
               <id>249</id>
               <name>$5 Support a Kid</name>
            </campaign>
            <campaign>
               <id>276</id>
               <name>1234</name>
            </campaign>
         </campaigns>
      </ns2:listcampaignsresponse>
   </soap:body>
</soap:envelope>

Response Parameters

Name Required Description
campaign.id Yes Campaign ID
campaign.name Yes Campaign name