RegistrationEndpoint
The following resources are applicable:
- /registration/activate
- /registration/activate/msisdn
- /registration/check/msisdn
- /registration/create
- /registration/key/create
/registration/activate
Mount Point: /rest/registration/activate
POST
Activates (generates a real user) a previously generated registration. The registration can be generated either by sending a sms to a registration address or by calling the create registration function. The API Key needs the right to do that.
Error Codes
| 1 | Method is not allowed by this api key |
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 600 | The api key is invalid |
| 900 | The registration key is invalid |
| 901 | The registration is currently not possible |
| 902 | The registration msisdn is not verified |
Request Body
| element: | registrationActivateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | registrationActivateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/registration/activate/msisdn
Mount Point: /rest/registration/activate/msisdn
POST
Activates (generates a real user) a previously generated registration. The registration can only be generated by calling the create registration function. The API Key needs the right to do that.
Error Codes
| 1 | Method is not allowed by this api key |
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 400 | The msisdn verify pin is invalid |
| 600 | The api key is invalid |
| 901 | The registration is currently not possible |
| 903 | The registration msisdn is invalid. |
Request Body
| element: | registrationActivateMsisdnRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | registrationActivateMsisdnResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/registration/check/msisdn
Mount Point: /rest/registration/check/msisdn
POST
Checks if a registration exists for a msisdn. The registration can only be generated by calling the create registration function.
Error Codes
| 1 | Method is not allowed by this api key |
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 400 | The msisdn verify pin is invalid |
| 600 | The api key is invalid |
| 903 | The registration msisdn is invalid. |
Request Body
| element: | registrationCheckMsisdnRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | registrationCheckMsisdnResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/registration/create
Mount Point: /rest/registration/create
POST
Creates a registration. The creation will trigger an sms send to the phone with the information how to create an account
Error Codes
| 1 | Method is not allowed by this api key |
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 102 | The password has a wrong format (4-15 chars) |
| 103 | The given msisdn is already registered |
| 500 | The country is not allowed to login or register |
| 501 | The msisdn is invalid for the country |
| 600 | The api key is invalid |
| 901 | The registration is currently not possible |
| 903 | The registration was blocked, because a registration was requested shortly |
Request Body
| element: | registrationCreateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | registrationCreateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/registration/key/create
Mount Point: /rest/registration/key/create
POST
Creates a new registration key used to verify the mobile number via mobile originated sms. The returned key must be send to one of the registration msisdns (country config)
Error Codes
| 1 | Method is not allowed by this api key |
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 102 | The password has a wrong format (4-15 chars) |
| 600 | The api key is invalid |
| 901 | The registration is currently not possible |
Request Body
| element: | registrationCreateKeyRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | registrationCreateKeyResponse |
| media types: | */* application/xml application/json |
(no documentation provided)