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

Warning!

Passwords must not be on the banned password list (for example: "passw0rd", "pageseeder")

Note

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 will use 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 the 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
email The new member's email yes email
firstname The new member's first name yes string
member-password The new member's password yes string
surname The new member's last name yes string
member-username The new member's username no string member's email

Permission

Open to public but only accessible if PageSeeder template.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
0x1001 If the username contains the character '@'
0x1002 If the email address is invalid
0x1004 If the username or email are already in use
0x1005 If the maximum number of members on the server has been reached
0x100B If the Password is too long
0x100C Password must be specified
0x1015 If the Password is too weak
0x1016 If the Password is equal to the username
0x101B The first name and surname are required
0x101C Email is required

Created on , last edited on