Users
In the SOAP API, you can use these user-related methods:
createUser()
A user can be created by specifying the
XTMUserAdditionAPIobject. The information is divided into the following groups:user details (also contains: address details and instant messaging identifiers).
roles.
language combinations.
qualifications.
domains.
terminology rights.
roles descriptors (can be used instead of roles).
custom fields.
Most of the fields are optional. However, the following are mandatory and must be specified:
user details:
username.
password.
first name.
last name.
e-mail address.
roles.
Language Combinations are specified by specifying the Source language and Target language using language codes.
USER_ADDITION_ROLE_API– a list of possible roles:TRANSLATORLanguage Combinations group is mandatory.
REVIEWERLanguage Combinations group is mandatory.
CORRECTORLanguage Combinations group is mandatory.
TERMINOLOGY_EXPERTTerminology rights group is mandatory. If a terminology expert is not a global expert, then the term customer descriptor is also required.
PROJECT_MANAGERThere is an option to limit project visibility to only projects created by this user (
XTMUserProjectsVisibilityEnum).TM_EXPERT
XTMUserProjectsVisibilityEnum– possible options for project visibility for a Project Manager:Table 5. : XTMUserProjectsVisibilityEnum – possible options for project visibility for a Project ManagerOption
Description
CREATOROnly projects created by this user.
updateUser()
This method can be used to update the following user data:
user details: first name, last name, username, password, address.
custom fields.
updateUserActivity()
This method can be used to delete the specified users or LSPs. It requires a list of user descriptors and activity (
XTM_USER_ACTIVITY).XTM_USER_ACTIVITY– list of possible activities.DELETE
Deletes user.
findUser()
This method can be used to search for users. It is necessary to specify search parameters in the
XTMFindUserAPIobject. This method returns all users with details matching the given criteria.Possible criteria are: a list of
XTMUserBaseDescriptorAPIobjects and a list ofXTM_USER_ROLE_APIenumeration types.By default, language combinations for linguists are not provided. They can be obtained by setting the
fetchLanguagesfield in options.XTM_USER_ROLE_API– list of possible roles:PROJECT_MANAGER.TRANSLATOR.REVIEWER.CORRECTOR.TERMINOLOGY_EXPERT.TM_EXPERT.LSP.
createCustomerPM()
A Customer Project Manager can be created by specifying the
XTMCustomerPMAPIobject. The information is divided into the following groups:user details (contains also: address details and instant messaging identifiers).
customer descriptor.
terminology rights.
TM rights.
Most of the fields are optional. However, the following are mandatory and must be specified:
user details:
username.
password.
first name.
last name.
e-mail address.
customer descriptor.
TM (Translation Memory) rights can be set by using:
tmAccessRightsfield – set of TM rights (see TmRightAPI).tmAccess– if true, then all TM rights will be added.
CustomerAdminRoleAPI – possible Customer Project Manager roles:
Option | Description |
|---|---|
| Manager role. |
| Viewer role. |
WorkflowAccessLevelAPI – possible workflow access levels:
Option | Description |
|---|---|
| Trusted level. |
| Standard level. |
| Minimal level. |
TermRightAPI – possible terminology rights:
Option | Description |
|---|---|
| Export right. |
| Import right. |
| Add right. |
| View right. |
| Modify right. DEPRECATED. |
| Update and approve right. |
| Delete right. |
| Suggest right. |
TmRightAPI – possible TM rights:
Option | Description |
|---|---|
| Export rights. |
| Import rights. |
| View rights. |
| Update and delete rights. |
| Update right. |
| Delete right. |