General Information
...
| Name | Source | Mandatory | Type | Special Format | Description | |
|---|---|---|---|---|---|---|
| id | Query | YES | String | N/A | User ID | |
| username | Body | YES | String | alphanumeric with _ , - characters only | Username | |
| firstName | Body | YES | String | N/A | First Name | |
| lastName | Body | YES | String | N/A | Last Name | |
| Body | YES | String | Email Address Format (JSON Schema Validation) | |||
| status | Body | YES | String | 'active', 'inactive' , 'pendingNew' | restricted to either 'active', 'inactive', or 'pendingNew' | |
| groups | Body | NO | Array | Array of Strings | array of group code values | |
| profile | Body | NO | Object | N/A | Profile | |
...
Response schema
Follow this link to check out the response JSON response JSON Schema
SOAJS Error Codes
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |