pixiReportActiveLogins
Show snapshot of logged users on specified Tag (DateTime)
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
POST
https://apigateway.descartes.com/tms/pixi/pixiReportActiveLogins
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| IncludeMobileLicences | boolean | false | Switch: Return also used mobile licences Type: bit Default value: 0 Example: 0 or 1 Available from: AVA 17.10 (8.4.34.31829) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReportActiveLogins>
<IncludeMobileLicences>true</IncludeMobileLicences>
</pixiReportActiveLogins>
</Body>
</Envelope>Response
1. Users logged in
| Name | Type | Description |
|---|---|---|
| OnDate | string | Timestamp of the snapshot Type: datetime Available from: / (25.8.0.59841) |
| AppName | string | Type of login licence used Type: varchar (11) Available from: / (25.8.0.59841) |
| Username | string | User name + computer name that is connected to pixi* Type: varchar (100) Available from: / (25.8.0.59841) |
| UsersCount | integer | Always 0 Type: int Available from: / (25.8.0.59841) |
| ComputerName | string | Device name connected to the login Type: varchar (100) Available from: / (25.8.0.59841) |
| NrOfLicences | integer | Number of pixi* licences Type: int Available from: / (25.8.0.59841) |
Response Example
<PixiReportActiveLoginsPost200TextXmlResponse>
<OnDate>string</OnDate>
<UsersCount>0</UsersCount>
<Username>string</Username>
<AppName>string</AppName>
<ComputerName>string</ComputerName>
<NrOfLicences>0</NrOfLicences>
</PixiReportActiveLoginsPost200TextXmlResponse>HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiReportActiveLogins>
<IncludeMobileLicences xsi:type="xsd:boolean">0 or 1</IncludeMobileLicences>
</ns1:pixiReportActiveLogins>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiReportActiveLogins', [
'IncludeMobileLicences' => '0 or 1', // boolean
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}