updatePoints
This method allows for:
Adding and removing a user's points.
| Java class | |
|---|---|
| Request | web\wwwroot\ws\java\gmf\gamification\UpdatePointsRequestType.java |
| Return | web\wwwroot\ws\java\gmf\gamification\UpdatePointsRequestType.java |
Request:
| ID | Required | Description |
|---|---|---|
| IDUSER | X | User ID. |
| VLPOINTS | X | Number of points. |
| FGPOINTEVENT | X | Action type. 1 = sum, 2 = subtract. |
| ONLYBALANCE | X | Change type. 1 = Changes points balance only, 2 = Changes both points balance and points total. |
| DSJUSTIFY | X | Explanation. |
| QTDEADLINE | Days 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:
| ID | Description |
|---|---|
| Status | SUCCESS: SUCCESS FAILURE: FAILURE |
| Detail | SUCCESS: Record added FAILURE: Message regarding the error that occurred. |
| Code | SUCCESS: 1 FAILURE: Code for the error that occurred. |
| Code | Description |
|---|---|
| 2 | Null user ID #. |
| 3 | Points event must be a number between 1 and 3. |
| 4 | The ONLYBALANCE field accepts only values 1 and 2. |
| 5 | Invalid value for number of points. |
| 6 | The DSJUSTIFY field must be filled in. |
| 7 | Inexistent user. |
| 8 | Invalid value for Days until points expiration. |