Authentication Level:
This module delivers all client information.
| Name | Description | Authentication |
|---|---|---|
| activate | Check if client with given mail already exists. | Service |
| activate | Activate client by client. | Service |
| getPasswordHash | fetch password hash. | Service |
| register | Register client from outside. | Service |
| resetPassword | reset password. | Service |
| validatePasswordHash | validate password hash. | Service |
| edit | Edit personal client data, client login required. | Client |
| get | get personal client data, client login required. | Client |
| orders/get | Get single order for current client. | Client |
| orders/getAll | Get all orders of current client. | Client |
Authentication Level: Service
Description:
Check if client with given mail already exists.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| mail required | String | The client email to check for existance. |
null |
Authentication Level: Service
Description:
Activate client by client.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| data required | Object | Client data. |
null |
Authentication Level: Service
Description:
fetch password hash.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| username required | String | Unique client username. |
null |
| mail required | String | Unique client mail address. |
null |
| number required | String | Unique client number. |
null |
Authentication Level: Service
Description:
Register client from outside.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| data required | Object | Client data. |
null |
Authentication Level: Service
Description:
reset password.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| mail required | String | Unique client mail address. |
null |
| password required | String | new password phrase. |
null |
| lostpassword_hash required | String | current password reset hash from /service/clients/getPasswordHash. |
null |
Authentication Level: Service
Description:
validate password hash.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| mail required | String | Unique client mail address. |
null |
| lostpassword_hash required | String | current password reset hash from /service/clients/getPasswordHash. |
null |
Authentication Level: Client
Description:
Edit personal client data, client login required.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| data required | Object | Client data. |
null |
Authentication Level: Client
Description:
get personal client data, client login required.
Parameter:
No parameter available for this route
Authentication Level: Client
Description:
Get single order for current client by id or uuid.
Request parameter:
| Field | Type | Description | Default |
|---|---|---|---|
| id | Integer | Unique order ID. |
null |
| uuid | String | Order UUID. |
null |
Authentication Level: Client
Description:
Get all orders of current client
Parameter:
No parameter available for this route