Skip to main content
Version: 2.2.0

newRole

This method allows adding a new functional role. To insert each of these items, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/generic/NewRoleRequestType.java
Returnweb/wwwroot/ws/java/generic/NewRoleResponseType.java

Request:

ID #RequiredDescription
IdRoleXFunctional role ID #
NmRoleXFunctional role name
IdRoleOwnerUpper level functional role ID #
DescriptionFunctional role description
ComponentsList with the code(s) of the components to be associated according to Suite shortcuts.
Examples:
Administration => ad
Time Control => tc
Process => pm
Project => pr

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:generic">
<soapenv:Header/>
<soapenv:Body>
<urn:newRole>
<!--You may enter the following 5 items in any order-->
<urn:IdRole>?</urn:IdRole>
<urn:NmRole>?</urn:NmRole>
<!--Optional:-->
<urn:IdRoleOwner>?</urn:IdRoleOwner>
<!--Optional:-->
<urn:Description>?</urn:Description>
<urn:Components>
<!--1 to 100 repetitions:-->
<urn:item>?</urn:item>
</urn:Components>
</urn:newRole>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
StatusSUCCESS: SUCCESS
FAILURE: FAILURE
DetailSUCCESS: Record(s) added.
FAILURE: message regarding the error that occurred.
CodeSUCCESS: 1.
FAILURE: Code regarding the error that occurred.
RecordIdSUCCESS: Functional role ID #.
FAILURE: N/A
RecordKeySUCCESS: Functional role primary key.
FAILURE: N/A
CodeDescription
43The ID # has no value
44Name has no value
45Existing record
46The upper level functional role does not exist
47Invalid component