API Docs
Create user
Contents
This Web service creates a new user.
Resource URL
POST /almaws/v1/users
API Description
URL Parameters
None
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
social_authentication | xs:string | Optional. Default: false | When customer parameter social_authentication='True': Send social authentication email to patron. Default value: False. |
send_pin_number_letter | xs:string | Optional. Default: false | The email notification for PIN setting change will be sent |
source_institution_code | xs:string | Optional. | The code of the source institution to which the user should be linked. Optional |
source_user_id | xs:string | Optional. | The ID of the user in the source institution. Optional. |
registration_rules | xs:string | Optional. Default: false | Apply registration rules in the context of the library. True or false. Optional. |
library | xs:string | Optional. | The code of the library. For use with registration rules. Optional. |
Body Parameters
This method takes a User object. See doc
Output
This method returns a User
object. See doc
Possible Error Codes
Code | Message |
---|---|
401676 | No valid XML was given. |
401851 | User with identifier of type Y already exists. |
401664 | Mandatory field is missing: X |
401852 | Given user group is not legal. |
401853 | External Id must be empty for internal user. |
401854 | External Id must be given for external user. |
401855 | The account type 'Internal with external authentication' is currently not supported. |
500038 | New password must be at least 8 characters long and must not include the user-name or any commonly used password. |
401857 | The given user account type is illegal (must be INTERNAL/EXTERNAL). |
401658 | General Error - Failed to create new user |
401863 | Given X type (Y) is not supported for given user record type (Z). |
401864 | Given X type (Y) is invalid. |
401651 | Source institution not valid or not part of fulfillment network. |
60224 | Organization institution not found. |
60225 | Fulfillment network not found. |
60226 | Fulfillment network copied user not found. |
60227 | Linked account for user already exists. |
60228 | Failed to create linked user account. |
60231 | Failed to link user due to identifier issues. |
60232 | Failed to link user due to user group empty. |