register member
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9100 | 6.0000 | json, xml |
Description
Self-register a member
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 globalTemplate
global 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
Name | Description | Required | Type | Default value |
---|---|---|---|---|
The new member’s email address | yes | |||
firstname | The new member’s given name | yes | string | |
member-password | The new member’s password | yes | string | |
surname | The new member’s family name | yes | string | |
member-username | The new member’s username | no | string | member's email |
notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
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
Code | Cause / 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 |
0x1007 | If the Firstname or Surname is too long |
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 |