REST API for Oracle Banking Collections

Add New User Group

post

/api/1.0/usergroup

This endpoint is used to add a new User Group.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

The application ID of host service.
branchCode(required): string

The branch code of requesting branch.
contentType: string

The content type of request or response body.
userId(required): string

The user ID of requesting user.

Request Body contain data required for creating a new User Group.

Root Schema : DmTmUserGroupDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmUserGroupDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "userGroupCd":{
                    "description":"User Group code",
                    "type":"string"
                },
                "userGroupDescr":{
                    "description":"User Group description",
                    "type":"string"
                },
                "hirachyOrder":{
                    "description":"Hierarchy order",
                    "type":"integer"
                },
                "supervisoryGroupCd":{
                    "description":"Supervisory Group code",
                    "type":"string"
                },
                "defaultAssigneeFlg":{
                    "description":"Default Assignee Flag",
                    "type":"boolean"
                },
                "DmTmUserGroupMembersDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmUserGroupMembersDTO"
                    }
                }
            }
        }
    ]
}

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 : DmTmUserGroupDTO-allOf[1]

Type: object

Show Source

defaultAssigneeFlg: boolean

Default Assignee Flag
DmTmUserGroupMembersDTO: array DmTmUserGroupMembersDTO
hirachyOrder: integer

Hierarchy order
supervisoryGroupCd: string

Supervisory Group code
userGroupCd: string

User Group code
userGroupDescr: string

User Group description

{
    "type":"object",
    "properties":{
        "userGroupCd":{
            "description":"User Group code",
            "type":"string"
        },
        "userGroupDescr":{
            "description":"User Group description",
            "type":"string"
        },
        "hirachyOrder":{
            "description":"Hierarchy order",
            "type":"integer"
        },
        "supervisoryGroupCd":{
            "description":"Supervisory Group code",
            "type":"string"
        },
        "defaultAssigneeFlg":{
            "description":"Default Assignee Flag",
            "type":"boolean"
        },
        "DmTmUserGroupMembersDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmUserGroupMembersDTO"
            }
        }
    }
}

Nested Schema : DmTmUserGroupMembersDTO

Type: array

Show Source

Array of: object DmTmUserGroupMembersDTO

User group Members Details.

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

Nested Schema : DmTmUserGroupMembersDTO

Type: object

User group Members Details.

Show Source

activeFlg: boolean

Active Flag
id: string

ID
userGroupMasterId: string

User group Master ID
userId: string

User ID
userName: string

User Name

{
    "description":"User group Members Details.",
    "type":"object",
    "properties":{
        "userId":{
            "description":"User ID",
            "type":"string"
        },
        "userName":{
            "description":"User Name",
            "type":"string"
        },
        "activeFlg":{
            "description":"Active Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "userGroupMasterId":{
            "type":"string",
            "description":"User group Master ID"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

New User group added successfully.

Headers

Location: string

URL of newly created User Group.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

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

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "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.