Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

addMemberToList

This will An application should be able to use the web service to add a new member to a Moira list. The web service will need to know the following information:

  1. On whose behalf is this change being made? I.e. What is the name of the authenticated user attempting to use this service?
  2. The name of the list to be modified.
  3. The type of member being added to the list (user, kerberos, string, machine).
  4. The name of the member being added to the list.

This call will return:

  1. format of data
  2. error indicators
  3. success indicator

Input parsing

specified Moira list.


API syntax:

No Format

public boolean addMemberToList(
        String listName,
        String memberID,
        String memberType,
        String proxyID)

throws moirawsException;

Parameters:

  •  listName:string that contains the Moira list name to which the member specified in the memberID parameter is to be added.  This is a required parameter. 
  • memberID: string that contains the member that is to be added to the Moira list specified in the listName parameter.  This is a required parameter. 
  • memberType: string that contains the Moira type of the member contained in the memberID parameter.  The supported Moira memberType(s) are: KERBEROS, LIST, STRING, USER.  This is a required parameter. 
  • proxyID: string the contains the user upon whose behalf the web service is adding the memberID to the listName.  This is usually the Kerberos principal of a user who has administrative access to the specified Moira list.  This is an optional parameter.  If this parameter is not used, it must be set either to null or an empty stirng (""). 

Return value:

The addMemberToList API returns a boolean true if the specified memberID is successfully added to the specified list.  If the member cannot be added to the specified list, either a boolean false is returned or and exception will be thrown.

See: https://jira.mit.edu/jira/browse/ZWS-1The web service will perform the following types of parameter validation ...