Page tree
Skip to end of metadata
Go to start of metadata

Award users with points and specify the reason for awarding them with the awardGamificationPoints method.

Permission to run the request: Account Owner, Account Administrators, Department Administratorsor users with a custom role able to edit users.

Department Administrators can award with points only users belonging to the department they manage and its sub-departments.

Request Parameters

Parameter

Type

Description

credentials (required)credentialsRead the description of the Credentials object.
userId (required)stringThe ID of the user whom you want to award with points.
amount (required)stringThe amount of points to be awarded.
reason (required)stringThe reason for awarding the points.

Possible Errors

Type

Description

Permission deniedThe user doesn't have enough permissions to fulfill the request..
Wrong parameters

The request can't be processed as it doesn't include all the necessary parameters or some of the parameters are wrong.

Sample Request

<?xml version="1.0" encoding="utf-8"?>
  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                     xmlns="http://ispringlearn.com/go/services/api/soap">
    <SOAP-ENV:Body>
      <AwardGamificationPointsRequest>
        <credentials>
          <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
          <email>email@email.com</email>
          <password>password</password>
        </credentials>
        <userId>2c180ffc-8841-11e9-b68a-0242c0a85016</userId>
        <amount>80</amount>
        <reason>Successful course completion</reason>
      </AwardGamificationPointsRequest>
    </SOAP-ENV:Body>
  </SOAP-ENV:Envelope>

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
		xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
		<SOAP-ENV:Body>
			<ns1:SuccessResult>
				<ns1:success>true</ns1:success>
			</ns1:SuccessResult>
		</SOAP-ENV:Body>
	</SOAP-ENV:Envelope>


  • No labels