Servlet: ImportMembers

Description

Imports members from comma-separated data.

HTTP method: GET

Returns data to produce the form for importing members.

HTTP method: POST

Actually import the members into PageSeeder.

Import data

The data uses comma-separated values as:

[firstname],[surname],[email],[username?],[password?],[field1?], ... ,[field15?]

• If a value contains a comma, it should be wrapped by double quotes ".
• It is not possible to include a line delimiter in a value, line delimiters are automatically interpreted as a separate member.
• If the password is the encrypted form used in the PageSeeder database the encrypted password will be preserved. This is useful for migrating members to a different server but they must be exported using an SQL query.

To import the users into a group, use the group parameter. The membership details can be set using the notification, role and listed parameters.

Error handling

If a user already exists, the existing details are returned instead of the original details sent in the request. The details sent in the import data do NOT overwrite the existing data. The existing user will be added to a group if specified and they are not already a member of said group.

If the data is parsable, but a row has invalid data, it is returned as a failed user. Possible failures are:

• empty first name, surname or email (use No Email instead)
• no email and no username (one is required)
• invalid or forbidden email
• first name or surname too long
• password too weak
• password missing for new members

If a parsing error occurs, this method returns an error message with HTTP status 400 (Bad Request).

XML output

The returned XML is in the form:

<root>
  <group><!-- Group --></group>
  <totalread>[lines read]</totalread>
  <created>
    <member><!-- Created Member #1 --></member>
    <member><!-- Created Member #2 --></member>
    <member><!-- Created Member #3 --></member>
    ...
  </created>
  <failed>
    <memberdetails><!-- Failed Member #1 --></memberdetails>
    <memberdetails><!-- Failed Member #2 --></memberdetails>
    <memberdetails><!-- Failed Member #3 --></memberdetails>
    ...
  </failed>
  <existing>
    <memberdetails><!-- Existing Member #1 --></memberdetails>
    <memberdetails><!-- Existing Member #2 --></memberdetails>
    <memberdetails><!-- Existing Member #3 --></memberdetails>
    ...
  </existing>
</root>

HTTP parameters

Notification

The notification parameter must be one of immediate, essential, daily, weekly or none. Users are able to change this setting at another time through the user interface in their group registration options.

Role

The role parameter must be one of guest, reviewer, contributor, manager, approver.