Skip to main content

 Web service API

How to use PageSeeder's Web service API

register member

/members/register [POST]

com.pageseeder.member.Register

Description

Self-register a member

Passwords must not be on the banned password list (for example: “passw0rd”, “pageseeder”)
If longer passwords are used, it is not necessary to include digits or special characters!

Allows a user to create a PageSeeder member account.

Use this service to create a new account for a member in PageSeeder but without joining the member to a group.

Email templates

This service uses the default PageSeeder templates.

To use customized emails, use the customFolder template property.

Member details

Both the firstname and surname are limited to 20 characters.

The member-username must be less than 100 characters, unique and cannot contain a ‘@’. The username is required unless an email address is specified.

The email must be less than 100 characters, unique and be a valid Email address. The email address is required unless a username is specified.

The member-password must be less than 100 characters. The password is required and must have at least a MEDIUM strength.

Parameters

NameDescriptionRequiredTypeDefault value
emailThe new member’s email addressyesemail
firstnameThe new member’s given nameyesstring
member-passwordThe new member’s passwordyesstring
surnameThe new member’s family nameyesstring
member-usernameThe new member’s usernamenostringmember's email
notify-asyncWhether emails should be sent asynchronously (for slow email servers)nobooleanfalse

Permission

Open to public but only accessible if PageSeeder global.properties contains publicEnable=self-register.

Email templates

Response

<member-creation [welcome-email-failed="true"]>
  <member id="[member id]"
          firstname="[first name]"
          surname="[surname]"
          username="[username]"
          email="[email]"
          status="[activated|unactivated]">
    <fullname>[full name]</fullname>
  </member>
</member-creation>
 

Error Handling

CodeCause / Description
0x1001If the username contains the character ‘@’
0x1002If the email address is invalid
0x1004If the username or email are already in use
0x1005If the maximum number of members on the server has been reached
0x1007If the Firstname or Surname is too long
0x100BIf the Password is too long
0x100CPassword must be specified
0x1015If the Password is too weak
0x1016If the Password is equal to the username
0x101BThe first name and surname are required
0x101CEmail is required
Created on , last edited on