Preferences_IsEntityRestricted Operation

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Use the Preferences_IsEntityRestricted method to determine whether a security entity specified by its code is available for a user. You can view the list of existing security entities in  > Setup > Security > Security Entities in QAComplete.

Parameters

The operation uses the following parameters:

AuthenticationData  :  , required

An AuthenticationData object containing the login information.

EntityName  :  string, required

Name of the security entity you want to check.

Result

True if the entity is restricted (not available for a user). False otherwise.

Example

Sample Code

C#

string login = "john.doe@example.com";
string password = "p@ssword";

ServiceSoapClient service = new ServiceSoapClient();

// Prepare AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = loginInfo.ProjId;

string entityName = "FunctSpecs-AllowApprove";
bool result = service.Preferences_IsEntityRestricted(authData, entityName);
Console.WriteLine(result.ToString());

Java

String login = "john.doe@example.com";
String password = "p@ssword";

ServiceSoap service = new Service().getServiceSoap12();

// Prepare AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(loginInfo.getProjId());

String entityName = "FunctSpecs-AllowApprove";
Boolean result = service.preferencesIsEntityRestricted(authData, entityName);
System.out.println(result);

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 553 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/Preferences_IsEntityRestricted"
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Preferences_IsEntityRestricted xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityName>FunctSpecs-AllowApprove</EntityName>
    </Preferences_IsEntityRestricted>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 561 {Insert an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Preferences_IsEntityRestricted xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>8162</DeptId>
        <ProjId>11873</ProjId>
        <UserId>24661</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <EntityName>FunctSpecs-AllowApprove</EntityName>
    </Preferences_IsEntityRestricted>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 445 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Preferences_IsEntityRestrictedResponse xmlns="http://www.pragmaticsw.com/">
      <Preferences_IsEntityRestrictedResult>false</Preferences_IsEntityRestrictedResult>
    </Preferences_IsEntityRestrictedResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 455 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Preferences_IsEntityRestrictedResponse xmlns="http://www.pragmaticsw.com/">
      <Preferences_IsEntityRestrictedResult>false</Preferences_IsEntityRestrictedResult>
    </Preferences_IsEntityRestrictedResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

Preferences_IsExtensionRestricted
Preference Operations
Helper Operations
SOAP API Reference

Highlight search results