|API Support||Since PageSeeder||Last updated||Documentation Date|
|3.3100||4.9500||18 December 2017|
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.
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.
In order to import the users into a group, use the group parameter. The membership details can be set using the notification, role and listed parameters.
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.
If the data is parsable but the email or username is invalid, it will be put as a failed user.
If a parsing error occurs, this method will return an error message with HTTP status 400 (Bad Request).
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> <member><!-- Failed Member #1 --></member> <member><!-- Failed Member #1 --></member> <member><!-- Failed Member #1 --></member> ... </failed> <existing> <member><!-- Existing Member #1 --></member> <member><!-- Existing Member #1 --></member> <member><!-- Existing Member #1 --></member> ... </existing> </root>
|data||The data to import (required).||yes||String|
|group||The name of the group the users should be imported into.||no||String|
|notification||The default notification for the users (applicable only if ||no||String|
|role||The default role for the users (applicable only if ||no||role||group's default|
|listed||Whether to list the email address of the imported users (applicable only if ||no||boolean|
|createpersonal||Whether to create a personal group for the user on import.||no||boolean|
The notification parameter must be one of "
weekly" or "
none". Users are able to change this setting later through the user interface in their group registration options.
The role parameter must be one of "