Develop > Web Service Interfaces > User Management Web Services Interface > User Management Web Services request reference

User Management Web Services request reference

The User Management Web Services interface supports the following requests:

ClosedUser service
Request Request Type Web Service Action
/user_object_list[/{userID}] GET

/<userID> is omitted: List all current users in the database.

/<userID> is specified: Get the user with ID<userID>.
POST

Create a user as specified in the posted XML data.

Note:

  • /<userID> must be omitted.
DELETE

Delete the user with ID <userID>.

Note:

  • /<userID> must be specified.
PUT

Edit the user with ID <userID>.

Note:

  • /<userID> must be specified.
ClosedTime zone service
Request Request Type Web Service Action
/time_zone_list GET

Lists all time zones that can be used when setting up new users.
ClosedUser group service
Request Request Type Web Service Action
/user_group_list[/{userGroupID}] GET

/<userGroupID> is omitted: List all current user groups in the database.

/<userGroupID> is specified: Get the user group with ID<userGroupID>.
POST

Create a user group as specified in the posted XML data.

Note:

  • /<userGroupID> must be omitted.
DELETE

Delete the user group with ID <userGroupID>.

Note:

  • /<userGroupID> must be specified.

PUT

Edit the user group with ID <userGroupID>.

Note:

  • /<userGroupID> must be specified.
ClosedLDAP user group service
Request Request Type Web Service Action
/ldap_group_list GET

Lists all groups available for the LDAP mapping as specified during the LDAP setup.
ClosedUser role service
Request Request Type Web Service Action
/role_list[/<roleID>] GET

/<roleID> is omitted: List all current roles in the database.

/<roleID> is specified: Get the role with ID<roleID>.
POST

Create a role as specified in the posted XML data.

Note:

  • /<roleID> must be omitted.

    Note When adding or modifying a role via the Web Service, permissions can be set on a view by adding/removing the following permission tags to the role:

    <permission>

    <resource_key>rtsm-view.{VIEW_NAME}</resource_key>

    <operation_key>{KEY}</operation_key>

    </permission>

    In the resource key, the VIEW_NAME must be specified to select which view receives the permission. The operation_key specifies the permitted operation. Possible values are change, view or delete.

DELETE

Delete the role with ID <roleID>.

Note:

  • /<roleID> must be specified.

PUT

Edit the role with ID <roleID>.

Note:

  • /<roleID> must be specified.
/role_list/user_object/<userID> GET

List all roles which are assigned to the user with the specified ID.
/role_list/user_group/{userGroupID} GET

List all roles which are assigned to the user group with the specified ID.
ClosedAuthorizable resource service
Request Request Type Web Service Action
/auth_resource_list GET

Lists all available authorizable resources that can be set in a role.
ClosedEvent category service
Request Request Type Web Service Action
/event_category_list[/{categoryID}] GET

/<categoryID> is omitted: List all current event categories in the database.

/<categoryID> is specified: Get the event category with ID<categoryID>.
POST

Create a event category as specified in the posted XML data.

Note:

  • /<categoryID> must be omitted.
DELETE

Delete the event category with ID <categoryID>.

Note:

  • /<categoryID> must be specified.
PUT

Edit the event category with ID <categoryID>.

Note:

  • /<categoryID> must be specified.

Send Help Center feedback