Used to register a user.
URL
EAPI_URL:7512/eapi/registration/register/1/1.1/
Example
EAPI_URL:7512/eapi/registration/register/1/1.1/?username=johndoe&password=1234678&givenname=John&surname=Doe&email=johndoe@example.com&msisdn=1111111111
| Parameter | description | min length | max length | validation |
|---|---|---|---|---|
| username | 1 | 30 | alphanumeric and underscore | |
| password | 6 | 10 | alphanumeric, punctuation and whitespace | |
| givenname | 1 | 20 | alpha, punctuation and whitespace | |
| surname | 1 | 30 | alpha, punctuation and whitespace | |
| 1 | 60 | |||
| msisdn | 5 | 16 | numeric, no spaces or dashes |
| Parameter | description | min length | max length | validation |
|---|---|---|---|---|
| no_registration_sms | (0 or 1,default 0) - set to 1 to suppress a welcome SMS to the registrant’s msisdn | - | - | |
| no_registration_email | (0 or 1,default 0) - set to 1 to suppress a welcome email to the registrant’s email address | - | - | |
| telephone | 5 | 15 | numeric, no spaces or dashes | |
| fax | 5 | 15 | numeric, no spaces or dashes | |
| company | user’s company name | 1 | 30 | alphanumeric, punctuation and whitespace |
status_code|status_description|[CREATION_EXTRA_FLAGS]
Possible return values upon success: 0|newly_created_userid|NO_FREE_CREDITS_AVAILABLE
CREATION_EXTRA_FLAGS:
Possible return values upon error: 1|Username not available 3|Some validation error text 4|Some user creation error text 5|Unknown error
You should never depend on the value of status_description - only depend on status_code, which is a constant. However, status_description can contain useful information about the nature of failures when you are developing your initial application.
Any HTTP status code other than 200 should be considered transient, i.e. you should attempt to resend after some interval.