Programs Web Service
MethodProgramParticipationsRecordEnd
Description
This method allows the user to record the end of a specified CoreOne Program Participation.
Request (ProgramParticipationsRecordEnd)

Below are the parameters to successfully record the end of a CoreOne Program Participation. 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:int
id

This is an internal CoreOne Program Participation id.

These can be retrieved through using the ProgramParticiaptionsIndex (Method).
xml:int
record_endThese are the input parameters necessary to successfully record the end of a Program Participation.record_end
Response (ProgramParticipationsRecordEnd_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 recorded end of a program participation was successful a message "Update successful." will be returned. If however the recorded end of a program participation was not successful a message "Update Failed." will be returned.xml:string
Remarks

See Also
All Operations Resource GroupPrograms Web Service

 

 


© 2014-2018 All Rights Reserved.

Send comments on this topic.