Update Program Member

Update Program Member

This API is used to update a learner's record in a course session.

API Details

Signature of API call

connection.invokeApi(String uri, String realUserName, Map<String, String> requestParameters);

See details about invoking API in general

 

Parameter 1 - URI

enrollmentService.do

 

Parameter 2 - UserName

Username of the site admin

 

Parameter 3 - Request Parameters

Name Value
dispatch updateProgramMember
xml true
programId Program id
extId

If program id is not known, you can pass extId.

Either programId or extId must be specified.

ids

comma separated user ids (id of user in lms)

usernames

comma separated user names (login id of user in lms).

openIds

comma separated open ids 

Either ids or usernames or openIds must be specified.

startDate Start date of the learner, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds - optional
endDate

End date of the learner, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds - optional

dueDate

Due date of the learner, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds - optional

remove Remove learner from program - optional
award true | false - optional, send it only to award or reset award
score Float number - total points, optional
awardDate Award date (completion date) of the learner, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds - optional
awardExpDate Award expiration date (validity expiration date) of the learner, represented as epoch time in milliseconds - number of milliseconds that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap seconds - optional
quitProgram

Optional - set it to true, to mark user's status in program as Quit. Once user quit the program, he/she can not enroll in any available elective course sessions. Although the existing enrolled course sessions of the program will remain accessible as per the normal subscription validity criteria. 

If the original subscription is created by a coupon redemption, then quitProgram can be used to free up the coupon usage as well. To enable this behavior set FREE_COUPON_UPON_PROGRAM_QUIT = true in Site Details->Customization

 

 

Response

Response on successfully updating the coupon

HTTP Response Code = HttpServletResponse.SC_OK

Response XML

 

<response code="0">
   <msgs>
      <msg>
         <code>0226</code>
         <value>
            <![CDATA[Program member updated successfully]]>
         </value>
      </msg>
   </msgs>
</response>

 

Code Snippet

/* Check API Call for detail */

 

Map<String, String> parameters = new HashMap<String, String>();
populateMapForCouponUpdate(parameters);
String result = connection.invokeApi("couponService.do", "adminusername", parameters);
System.out.println(result);
 
private void populateMapForCouponUpdate(Map<String, String> parameters) {
    parameters.put("dispatch", "updateProgramMember
");
    parameters.put("xml", String.valueOf(true));
    parameters.put("programId", "xxxx-xxxx-xxxx-xxxx");
    parameters.put("usernames", "user1,user2");
    parameters.put("expDate", "1495163497116"); //Set end dates of learners
}

Rating: