API v1 Reference

Add Activity

This request creates an Activity record and adds it to an account.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/addActivity?userSessionId=T1356748716232&Activity.subject=subject&Activity.note=note&Activity.startDateTime=2012-11-19T15:00:54.063+08:00&Activity.endDateTime=2012-12-19T15:00:54.063+08:00&Activity.clientId=3480&Activity.systemUserId=3&Activity.activityStatus.id=1&Activity.activityStatus.name=Not Started&Activity.activityPriority=Normal

Response

{
    "addActivityResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2012-12-28T05:06:32.313-06:00",
        "activityId": 3
    }
}

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:addactivityrequest>
             <usersessionid>T1357624094982</usersessionid>
             <activity> 
                 <subject>test activity 1</subject>
                <note>note</note>
                <startdatetime>2012-11-19T15:00:23+08:00</startdatetime>
                <enddatetime>2012-12-19T15:00:54+08:00</enddatetime>
                <clientid>5786</clientid>
                <systemuserid>3</systemuserid>
                <activitystatus>
                   <id>2</id>
                </activitystatus>
                <activitypriority>Normal</activitypriority>
             </activity>
          </neon:addactivityrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:addactivityresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsedatetime>2013-01-08T00:03:18.238-06:00</responsedatetime>
         <activityid>1</activityid>
      </ns2:addactivityresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
Activity.subject Yes Subject field for the activity record.
Activity.note
Activity.startDateTime Yes Format example: [2012-11-19T15:35:53+08:00]
Activity.endDateTime Format example: [2012-11-19T15:35:53+10:00]
Activity.clientId Yes Account ID of the constituent record associated with this activity
Activity.systemUserId Yes Account ID of the system user associated with this activity
Activity.activityStatus.id Yes Possible values are found in the List Activity Status API method.
Activity.activityStatus.name Possible values are found in the List Activity Status API method.
Activity.activityPriority Yes Possible values: High, Normal, Low

Response Parameters

Name Required Description
activityId Yes The Activity ID of the record created

Error Codes

Code Text Description
10202 Client account id is invalid.
10203 System user id is invalid.
10204 Status id or name is required.
10205 Status id or name invalid.
10206 Subject is required.
10207 Priority is required.
10208 Start date time is required.