Activities Web Service
MethodActivityClose
Description
This method allows the user to close a specified CoreOne Activity.
Request (ActivityClose)

Below are the parameters to successfully close a specified CoreOne Activity. If any required parameter is omitted an error message will be displayed alerting the user.

Request Body Parameters

NameDescriptionData Type
token

This is a 40-character hexadecimal string.

This token should have been obtained at the commencement of a session using the Login (Method). It is required for all functional CoreOne web services.
xml:string
id

This is an internal CoreOne Activity_id.

These can be retrieved through using the ActivitiesIndex (Method).
xml:int
activity_closeThese are the input parameters necessary to successfully close an open Activity.activity_close
Response (ActivityClose_response)

This is the returned status message to tell the user the result of the method.

An error message will be displayed instead of the status message if any of the input parameters fail any validation rule. For example if the user's token is invalid or the record doesn't exist. It will alert the user on what parameter failed validation and the reason why.

Response Body Parameters

NameDescriptionData Type
statusIf the activity was successfully closed a message "Close successful." will be returned. If however the activity was not successfully closed a message "Close Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupActivities Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.