Skip to main content
Version: 2.2.3

updatePoints

This method allows for:

Adding and removing a user's points.

Java class
Requestweb\wwwroot\ws\java\gmf\gamification\UpdatePointsRequestType.java
Returnweb\wwwroot\ws\java\gmf\gamification\UpdatePointsRequestType.java

Request:

IDRequiredDescription
IDUSERXUser ID.
VLPOINTSXNumber of points.
FGPOINTEVENTXAction type. 1 = sum, 2 = subtract.
ONLYBALANCEXChange type. 1 = Changes points balance only, 2 = Changes both points balance and points total.
DSJUSTIFYXExplanation.
QTDEADLINEDays until points expiration.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:gamification">
<soapenv:Header/>
<soapenv:Body>
<urn:updatePoints>
<!--You may enter the following 6 items in any order-->
<urn:IDUSER>?</urn:IDUSER>
<urn:VLPOINTS>?</urn:VLPOINTS>
<urn:FGPOINTEVENT>?</urn:FGPOINTEVENT>
<urn:ONLYBALANCE>?</urn:ONLYBALANCE>
<urn:DSJUSTIFY>?</urn:DSJUSTIFY>
<urn:QTDEADLINE>?</urn:QTDEADLINE>
</urn:updatePoints>
</soapenv:Body>
</soapenv:Envelope>

Return:

IDDescription
StatusSUCCESS: SUCCESS
FAILURE: FAILURE
DetailSUCCESS: Record added
FAILURE: Message regarding the error that occurred.
CodeSUCCESS: 1
FAILURE: Code for the error that occurred.
CodeDescription
2Null user ID #.
3Points event must be a number between 1 and 3.
4The ONLYBALANCE field accepts only values 1 and 2.
5Invalid value for number of points.
6The DSJUSTIFY field must be filled in.
7Inexistent user.
8Invalid value for Days until points expiration.