Adds a new user
post
/service/user
This endpoint is used to add a new user.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
sourceCode: string
Source from which request is initiated
Request Body that contains data required for creating a new user
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : UserDto-allOf[1]
Type:
Show Source
object-
customerNo(optional):
string
-
endDate(optional):
string
-
homeBranch:
string
Minimum Length:
0Maximum Length:3 -
homePhone(optional):
string
Minimum Length:
0Maximum Length:50 -
isSupervisor:
string
Minimum Length:
0Maximum Length:1 -
languageCode:
string
Minimum Length:
0Maximum Length:3 -
locale(optional):
string
Minimum Length:
0Maximum Length:10 -
managerId(optional):
string
Minimum Length:
0Maximum Length:12 -
piiEnabled(optional):
boolean
PII Enabled
-
staffAccRestriction(optional):
string
-
startDate:
string
-
statusChangedOn(optional):
string
-
telephoneNumber(optional):
string
Minimum Length:
0Maximum Length:50 -
theme(optional):
string
Minimum Length:
0Maximum Length:100 -
UserApplications(optional):
array UserApplications
-
userEmail(optional):
string
Minimum Length:
0Maximum Length:50 -
userFax(optional):
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+?[0-9]{6,}$ -
userLoginId:
string
Minimum Length:
0Maximum Length:12 -
userMobile(optional):
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+[1-9]{1}[0-9]{3,14}$ -
userName:
string
Minimum Length:
0Maximum Length:100 -
UserRoleBranches(optional):
array UserRoleBranches
-
userStatus:
string
Minimum Length:
0Maximum Length:1
Nested Schema : UserApplications
Type:
Show Source
object-
applicationDescription(optional):
string
Application description
-
applicationId:
string
Minimum Length:
0Maximum Length:36 -
applicationName(optional):
string
Application name
-
id(optional):
string
Minimum Length:
0Maximum Length:36 -
userId(optional):
string
Minimum Length:
0Maximum Length:36
Nested Schema : UserRoleBranches
Type:
Show Source
object-
branchCode:
string
Minimum Length:
0Maximum Length:3 -
branchId:
string
Minimum Length:
0Maximum Length:36 -
id(optional):
string
Minimum Length:
0Maximum Length:36 -
roleCode(optional):
string
-
roleDescription(optional):
string
-
roleId:
string
Minimum Length:
0Maximum Length:36 -
userId(optional):
string
Minimum Length:
0Maximum Length:36
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created user
Root Schema : UserServiceDtoWrapper
Type:
Show Source
object-
data(optional):
object UserDto
-
messages(optional):
object ResponseDto
Nested Schema : ResponseDto
Type:
Show Source
object-
codes(optional):
array codes
-
id(optional):
string
-
requestId(optional):
string
-
status(optional):
string
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : UserDto-allOf[1]
Type:
Show Source
object-
customerNo(optional):
string
-
endDate(optional):
string
-
homeBranch:
string
Minimum Length:
0Maximum Length:3 -
homePhone(optional):
string
Minimum Length:
0Maximum Length:50 -
isSupervisor:
string
Minimum Length:
0Maximum Length:1 -
languageCode:
string
Minimum Length:
0Maximum Length:3 -
locale(optional):
string
Minimum Length:
0Maximum Length:10 -
managerId(optional):
string
Minimum Length:
0Maximum Length:12 -
piiEnabled(optional):
boolean
PII Enabled
-
staffAccRestriction(optional):
string
-
startDate:
string
-
statusChangedOn(optional):
string
-
telephoneNumber(optional):
string
Minimum Length:
0Maximum Length:50 -
theme(optional):
string
Minimum Length:
0Maximum Length:100 -
UserApplications(optional):
array UserApplications
-
userEmail(optional):
string
Minimum Length:
0Maximum Length:50 -
userFax(optional):
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+?[0-9]{6,}$ -
userLoginId:
string
Minimum Length:
0Maximum Length:12 -
userMobile(optional):
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+[1-9]{1}[0-9]{3,14}$ -
userName:
string
Minimum Length:
0Maximum Length:100 -
UserRoleBranches(optional):
array UserRoleBranches
-
userStatus:
string
Minimum Length:
0Maximum Length:1
Nested Schema : UserApplications
Type:
Show Source
object-
applicationDescription(optional):
string
Application description
-
applicationId:
string
Minimum Length:
0Maximum Length:36 -
applicationName(optional):
string
Application name
-
id(optional):
string
Minimum Length:
0Maximum Length:36 -
userId(optional):
string
Minimum Length:
0Maximum Length:36
Nested Schema : UserRoleBranches
Type:
Show Source
object-
branchCode:
string
Minimum Length:
0Maximum Length:3 -
branchId:
string
Minimum Length:
0Maximum Length:36 -
id(optional):
string
Minimum Length:
0Maximum Length:36 -
roleCode(optional):
string
-
roleDescription(optional):
string
-
roleId:
string
Minimum Length:
0Maximum Length:36 -
userId(optional):
string
Minimum Length:
0Maximum Length:36
Nested Schema : ResponseCode
Type:
Show Source
object-
arg(optional):
string
-
args(optional):
array args
-
Code(optional):
string
-
Desc(optional):
string
-
Language(optional):
string
-
Type(optional):
string
Nested Schema : items
Type:
object400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error