Request Number of Question to Reset API
Call this function to know how many question need to be reset.
Below is the URL to access the API functions:
PUT /CentagateWS/webresources/security/getNumOfQuestionsToSetBPI
Parameters
No | Parameters | Occurrence | Descriptions |
---|---|---|---|
1 | username | Required | The user's username |
Sample Code
As in below there are some examples of source code of access the API functions:
Java
public static void main(String[] args) {
ClientConfig config = new DefaultClientConfig ();
Client client = Client.create ( config );
WebResource service = client.resource ("https://<domain_name>/CentagateWS/webresources");
Gson gson = new Gson();
HashMap<String, String> map = new HashMap<String, String>();
map.put("username", "username");
ClientResponse response = service.path("security").path("getNumOfQuestionsToSetBPI").accept(MediaType.APPLICATION_JSON).put(ClientResponse.class, gson.toJson(map));
String retJson = response.getEntity(String.class);
HashMap<String, Object> returnData = (HashMap<String, Object>) gson.fromJson(retJson, HashMap.class);
String code = returnData.get("code").toString();
String message = returnData.get("message").toString();
String object = returnData.get("object").toString();
}
Node Js
const https = require('https')
var crypto = require('crypto');
var username = "<username>";
const data = JSON.stringify({
username: username
})
const options = {
hostname: "<domain_name>",
port: 443,
path:'/CentagateWS/webresources/security/getNumOfQuestionsToSetBPI',
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
}
}
const req = https.request(options, res =>{
console.log(`HTTP Status Code: ${res.statusCode}`)
var body = '';
res.on('data', function(d){
body += d;
var parsed = JSON.parse(body);
if (parsed.code == 0){
console.log('Authentication Succeed');
console.log('Response:');
console.log(body);
}
else {
console.log('Authentication Fail, ' +'Message:' + parsed.message);
console.log('Code:' + parsed.code);
}
})
})
req.on('ERROR', error => {
console.error(error)
})
req.write(data)
req.end()
PHP
<?php
$url = 'https://<domain_name>/CentagateWS/webresources/security/getNumOfQuestionsToSetBPI';
$ch = curl_init($url);
$username = "<username>";
$jsonData = array (
'username'=> $username
);
$jsonDataEncoded = json_encode($jsonData);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonDataEncoded);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
$obj = json_decode($result);
if ($obj->{'code'} != 0){
print "Authentication fail";
print "Message: ".$obj->{'message'};
echo " <br>";
print "Code: ".$obj->{'code'};
}
else {
print "Authentication succeed";
echo " <br>";
print "Message: ".$obj->{'message'};
echo " <br>";
print "Code: ".$obj->{'code'};
echo " <br>";
print "Result:" ;
echo " <br>";
print $result;
}
curl_close($ch);
?>
Error Code
Return Code | Details |
---|---|
0 | Success |
10001 | Permission not allowed |
10002 | Invalid Input |
10003 | DB protection error |
10004 | DB error |
10011 | Crypto error |
22002 | User not found |