Skip to main content

SOAP API

Users

In the SOAP API, you can use these user-related methods:

  1. createUser()

    A user can be created by specifying the XTMUserAdditionAPI object. 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:

    • TRANSLATOR

      Language Combinations group is mandatory.

    • REVIEWER

      Language Combinations group is mandatory.

    • CORRECTOR

      Language Combinations group is mandatory.

    • TERMINOLOGY_EXPERT

      Terminology rights group is mandatory. If a terminology expert is not a global expert, then the term customer descriptor is also required.

    • PROJECT_MANAGER

      There 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 Manager

    Option

    Description

    CREATOR

    Only projects created by this user.


  2. updateUser()

    This method can be used to update the following user data:

    • user details: first name, last name, username, password, address.

    • custom fields.

  3. 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.

  4. findUser()

    This method can be used to search for users. It is necessary to specify search parameters in the XTMFindUserAPI object. This method returns all users with details matching the given criteria.

    Possible criteria are: a list of XTMUserBaseDescriptorAPI objects and a list of XTM_USER_ROLE_API enumeration types.

    By default, language combinations for linguists are not provided. They can be obtained by setting the fetchLanguages field in options.

    XTM_USER_ROLE_API – list of possible roles:

    • PROJECT_MANAGER.

    • TRANSLATOR.

    • REVIEWER.

    • CORRECTOR.

    • TERMINOLOGY_EXPERT.

    • TM_EXPERT.

    • LSP.

  5. createCustomerPM()

    A Customer Project Manager can be created by specifying the XTMCustomerPMAPI object. 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:

  • tmAccessRights field – set of TM rights (see TmRightAPI).

  • tmAccess – if true, then all TM rights will be added.

CustomerAdminRoleAPI – possible Customer Project Manager roles:

Table 6. : CustomerAdminRoleAPI – possible Customer Project Manager roles

Option

Description

MANAGER

Manager role.

VIEWER

Viewer role.


WorkflowAccessLevelAPI – possible workflow access levels:

Table 7. : WorkflowAccessLevelAPI – possible workflow access levels

Option

Description

TRUSTED

Trusted level.

STANDARD

Standard level.

MINIMAL

Minimal level.


TermRightAPI – possible terminology rights:

Table 8. : TermRightAPI – possible terminology rights

Option

Description

EXPORT

Export right.

IMPORT

Import right.

ADD

Add right.

VIEW

View right.

MODIFY

Modify right. DEPRECATED.

UPDATE_APPROVE

Update and approve right.

DELETE

Delete right.

SUGGEST

Suggest right.


TmRightAPI – possible TM rights:

Table 9. : TmRightAPI – possible TM rights 

Option

Description

EXPORT_TM

Export rights.

IMPORT_TM

Import rights.

VIEW_TM

View rights.

MODIFY_TM

Update and delete rights.

MODIFY_UPDATE_ONLY_TM

Update right.

DELETE_TM

Delete right.