Previous Next JavaScript must be enabled to correctly display this content

## 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

Body ()
Request Body that contains data required for creating a new user
Root Schema : UserDto
Type: `object`
Match All
Show Source

- allOf GenericDto
- object UserDto-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "startDate":{
                        "type":"string"
                    },
                    "userStatus":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "endDate":{
                        "type":"string"
                    },
                    "staffAccRestriction":{
                        "type":"string"
                    },
                    "customerNo":{
                        "type":"string"
                    },
                    "statusChangedOn":{
                        "type":"string"
                    },
                    "userEmail":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "telephoneNumber":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "homePhone":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "userMobile":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50,
                        "pattern":"^$|^\\+[1-9]{1}[0-9]{3,14}$"
                    },
                    "userFax":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50,
                        "pattern":"^$|^\\+?[0-9]{6,}$"
                    },
                    "userLoginId":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":12
                    },
                    "userName":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":100
                    },
                    "isSupervisor":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "managerId":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":12
                    },
                    "homeBranch":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "theme":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":100
                    },
                    "locale":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":10
                    },
                    "piiEnabled":{
                        "description":"PII Enabled",
                        "type":"boolean"
                    },
                    "languageCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "UserApplications":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/UserApplications"
                        }
                    },
                    "UserRoleBranches":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/UserRoleBranches"
                        }
                    }
                },
                "required":[
                    "startDate",
                    "userStatus",
                    "userLoginId",
                    "userName",
                    "isSupervisor",
                    "homeBranch",
                    "languageCode"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : UserDto-allOf[1]
Type: `object`
Show Source

- customerNo(optional): string
- endDate(optional): string
- homeBranch: string
  Minimum Length: `0`
  Maximum Length: `3`
- homePhone(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- isSupervisor: string
  Minimum Length: `0`
  Maximum Length: `1`
- languageCode: string
  Minimum Length: `0`
  Maximum Length: `3`
- locale(optional): string
  Minimum Length: `0`
  Maximum Length: `10`
- managerId(optional): string
  Minimum Length: `0`
  Maximum Length: `12`
- piiEnabled(optional): boolean
  PII Enabled
- staffAccRestriction(optional): string
- startDate: string
- statusChangedOn(optional): string
- telephoneNumber(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- theme(optional): string
  Minimum Length: `0`
  Maximum Length: `100`
- UserApplications(optional): array UserApplications
- userEmail(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- userFax(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
  Pattern: `^$|^\+?[0-9]{6,}$`
- userLoginId: string
  Minimum Length: `0`
  Maximum Length: `12`
- userMobile(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
  Pattern: `^$|^\+[1-9]{1}[0-9]{3,14}$`
- userName: string
  Minimum Length: `0`
  Maximum Length: `100`
- UserRoleBranches(optional): array UserRoleBranches
- userStatus: string
  Minimum Length: `0`
  Maximum Length: `1`

    {
        "type":"object",
        "properties":{
            "startDate":{
                "type":"string"
            },
            "userStatus":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "endDate":{
                "type":"string"
            },
            "staffAccRestriction":{
                "type":"string"
            },
            "customerNo":{
                "type":"string"
            },
            "statusChangedOn":{
                "type":"string"
            },
            "userEmail":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "telephoneNumber":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "homePhone":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "userMobile":{
                "type":"string",
                "minLength":0,
                "maxLength":50,
                "pattern":"^$|^\\+[1-9]{1}[0-9]{3,14}$"
            },
            "userFax":{
                "type":"string",
                "minLength":0,
                "maxLength":50,
                "pattern":"^$|^\\+?[0-9]{6,}$"
            },
            "userLoginId":{
                "type":"string",
                "minLength":0,
                "maxLength":12
            },
            "userName":{
                "type":"string",
                "minLength":0,
                "maxLength":100
            },
            "isSupervisor":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "managerId":{
                "type":"string",
                "minLength":0,
                "maxLength":12
            },
            "homeBranch":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "theme":{
                "type":"string",
                "minLength":0,
                "maxLength":100
            },
            "locale":{
                "type":"string",
                "minLength":0,
                "maxLength":10
            },
            "piiEnabled":{
                "description":"PII Enabled",
                "type":"boolean"
            },
            "languageCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "UserApplications":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/UserApplications"
                }
            },
            "UserRoleBranches":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/UserRoleBranches"
                }
            }
        },
        "required":[
            "startDate",
            "userStatus",
            "userLoginId",
            "userName",
            "isSupervisor",
            "homeBranch",
            "languageCode"
        ]
    }

Nested Schema : UserApplications
Type: `array`
Show Source

- Array of: object UserApplications

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/UserApplications"
        }
    }

Nested Schema : UserRoleBranches
Type: `array`
Show Source

- Array of: object UserRoleBranches

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/UserRoleBranches"
        }
    }

Nested Schema : UserApplications
Type: `object`
Show Source

- applicationDescription(optional): string
  Application description
- applicationId: string
  Minimum Length: `0`
  Maximum Length: `36`
- applicationName(optional): string
  Application name
- id(optional): string
  Minimum Length: `0`
  Maximum Length: `36`
- userId(optional): string
  Minimum Length: `0`
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "userId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "applicationId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "applicationName":{
                "description":"Application name",
                "type":"string"
            },
            "applicationDescription":{
                "description":"Application description",
                "type":"string"
            }
        },
        "required":[
            "applicationId"
        ]
    }

Nested Schema : UserRoleBranches
Type: `object`
Show Source

- branchCode: string
  Minimum Length: `0`
  Maximum Length: `3`
- branchId: string
  Minimum Length: `0`
  Maximum Length: `36`
- id(optional): string
  Minimum Length: `0`
  Maximum Length: `36`
- roleCode(optional): string
- roleDescription(optional): string
- roleId: string
  Minimum Length: `0`
  Maximum Length: `36`
- userId(optional): string
  Minimum Length: `0`
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "branchCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "id":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "userId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "roleId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "branchId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "roleCode":{
                "type":"string"
            },
            "roleDescription":{
                "type":"string"
            }
        },
        "required":[
            "branchCode",
            "roleId",
            "branchId"
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string
  URL of newly created user

Body ()
Root Schema : UserServiceDtoWrapper
Type: `object`
Show Source

- data(optional): object UserDto
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/UserDto"
            }
        }
    }

Nested Schema : UserDto
Type: `object`
Match All
Show Source

- allOf GenericDto
- object UserDto-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "startDate":{
                        "type":"string"
                    },
                    "userStatus":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "endDate":{
                        "type":"string"
                    },
                    "staffAccRestriction":{
                        "type":"string"
                    },
                    "customerNo":{
                        "type":"string"
                    },
                    "statusChangedOn":{
                        "type":"string"
                    },
                    "userEmail":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "telephoneNumber":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "homePhone":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50
                    },
                    "userMobile":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50,
                        "pattern":"^$|^\\+[1-9]{1}[0-9]{3,14}$"
                    },
                    "userFax":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":50,
                        "pattern":"^$|^\\+?[0-9]{6,}$"
                    },
                    "userLoginId":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":12
                    },
                    "userName":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":100
                    },
                    "isSupervisor":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":1
                    },
                    "managerId":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":12
                    },
                    "homeBranch":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "theme":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":100
                    },
                    "locale":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":10
                    },
                    "piiEnabled":{
                        "description":"PII Enabled",
                        "type":"boolean"
                    },
                    "languageCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":3
                    },
                    "UserApplications":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/UserApplications"
                        }
                    },
                    "UserRoleBranches":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/UserRoleBranches"
                        }
                    }
                },
                "required":[
                    "startDate",
                    "userStatus",
                    "userLoginId",
                    "userName",
                    "isSupervisor",
                    "homeBranch",
                    "languageCode"
                ]
            }
        ]
    }

Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : UserDto-allOf[1]
Type: `object`
Show Source

- customerNo(optional): string
- endDate(optional): string
- homeBranch: string
  Minimum Length: `0`
  Maximum Length: `3`
- homePhone(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- isSupervisor: string
  Minimum Length: `0`
  Maximum Length: `1`
- languageCode: string
  Minimum Length: `0`
  Maximum Length: `3`
- locale(optional): string
  Minimum Length: `0`
  Maximum Length: `10`
- managerId(optional): string
  Minimum Length: `0`
  Maximum Length: `12`
- piiEnabled(optional): boolean
  PII Enabled
- staffAccRestriction(optional): string
- startDate: string
- statusChangedOn(optional): string
- telephoneNumber(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- theme(optional): string
  Minimum Length: `0`
  Maximum Length: `100`
- UserApplications(optional): array UserApplications
- userEmail(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
- userFax(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
  Pattern: `^$|^\+?[0-9]{6,}$`
- userLoginId: string
  Minimum Length: `0`
  Maximum Length: `12`
- userMobile(optional): string
  Minimum Length: `0`
  Maximum Length: `50`
  Pattern: `^$|^\+[1-9]{1}[0-9]{3,14}$`
- userName: string
  Minimum Length: `0`
  Maximum Length: `100`
- UserRoleBranches(optional): array UserRoleBranches
- userStatus: string
  Minimum Length: `0`
  Maximum Length: `1`

    {
        "type":"object",
        "properties":{
            "startDate":{
                "type":"string"
            },
            "userStatus":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "endDate":{
                "type":"string"
            },
            "staffAccRestriction":{
                "type":"string"
            },
            "customerNo":{
                "type":"string"
            },
            "statusChangedOn":{
                "type":"string"
            },
            "userEmail":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "telephoneNumber":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "homePhone":{
                "type":"string",
                "minLength":0,
                "maxLength":50
            },
            "userMobile":{
                "type":"string",
                "minLength":0,
                "maxLength":50,
                "pattern":"^$|^\\+[1-9]{1}[0-9]{3,14}$"
            },
            "userFax":{
                "type":"string",
                "minLength":0,
                "maxLength":50,
                "pattern":"^$|^\\+?[0-9]{6,}$"
            },
            "userLoginId":{
                "type":"string",
                "minLength":0,
                "maxLength":12
            },
            "userName":{
                "type":"string",
                "minLength":0,
                "maxLength":100
            },
            "isSupervisor":{
                "type":"string",
                "minLength":0,
                "maxLength":1
            },
            "managerId":{
                "type":"string",
                "minLength":0,
                "maxLength":12
            },
            "homeBranch":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "theme":{
                "type":"string",
                "minLength":0,
                "maxLength":100
            },
            "locale":{
                "type":"string",
                "minLength":0,
                "maxLength":10
            },
            "piiEnabled":{
                "description":"PII Enabled",
                "type":"boolean"
            },
            "languageCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "UserApplications":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/UserApplications"
                }
            },
            "UserRoleBranches":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/UserRoleBranches"
                }
            }
        },
        "required":[
            "startDate",
            "userStatus",
            "userLoginId",
            "userName",
            "isSupervisor",
            "homeBranch",
            "languageCode"
        ]
    }

Nested Schema : UserApplications
Type: `array`
Show Source

- Array of: object UserApplications

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/UserApplications"
        }
    }

Nested Schema : UserRoleBranches
Type: `array`
Show Source

- Array of: object UserRoleBranches

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/UserRoleBranches"
        }
    }

Nested Schema : UserApplications
Type: `object`
Show Source

- applicationDescription(optional): string
  Application description
- applicationId: string
  Minimum Length: `0`
  Maximum Length: `36`
- applicationName(optional): string
  Application name
- id(optional): string
  Minimum Length: `0`
  Maximum Length: `36`
- userId(optional): string
  Minimum Length: `0`
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "userId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "applicationId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "applicationName":{
                "description":"Application name",
                "type":"string"
            },
            "applicationDescription":{
                "description":"Application description",
                "type":"string"
            }
        },
        "required":[
            "applicationId"
        ]
    }

Nested Schema : UserRoleBranches
Type: `object`
Show Source

- branchCode: string
  Minimum Length: `0`
  Maximum Length: `3`
- branchId: string
  Minimum Length: `0`
  Maximum Length: `36`
- id(optional): string
  Minimum Length: `0`
  Maximum Length: `36`
- roleCode(optional): string
- roleDescription(optional): string
- roleId: string
  Minimum Length: `0`
  Maximum Length: `36`
- userId(optional): string
  Minimum Length: `0`
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "branchCode":{
                "type":"string",
                "minLength":0,
                "maxLength":3
            },
            "id":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "userId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "roleId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "branchId":{
                "type":"string",
                "minLength":0,
                "maxLength":36
            },
            "roleCode":{
                "type":"string"
            },
            "roleDescription":{
                "type":"string"
            }
        },
        "required":[
            "branchCode",
            "roleId",
            "branchId"
        ]
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/ResponseCode"
        }
    }

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 400 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
Back to Top