REST API for Oracle Banking Collections

Get All Valid User Assignment

get

/api/1.0/userassignment

This service is used to get all valid User Assignment maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

assigmentMethodCd: string

Assignment Method of the User Assignment that needs to be fetched.
assignmentCd: string

Code of the User Assignment that needs to be fetched.
assignmentDescr: string

Description of the User Assignment that needs to be fetched.
authStatus: string

Authorization status of the User Assignment to be fetched.
ignoreGroupBasisFlg: string

Ignore Group Basis of the User Assignment that needs to be fetched.
includecloseandunauth: boolean

Include close and unauthorized value need to be provided to fetch summary record, default value is false.
limit: integer

Limit is maximum number of records to be fetched.
offset: integer

Offset is starting number of records to be fetched.
recordStatus: string

Record status of the User Assignment to be fetched.

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.

Response

Supported Media Types

application/json
application/xml

201 Response

Returns valid User Assignments.

Headers

Location: string

URL details.

Root Schema : DmTmUserAssignmentCollection

Type: object

Collection of User Assignments.

Show Source

data: array data
paging: object PagingDto

Paging data transfer object.

{
    "description":"Collection of User Assignments.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmUserAssignmentDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object DmTmUserAssignmentDTO

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

Nested Schema : PagingDto

Type: object

Paging data transfer object.

Show Source

totalResults: integer

Total results

{
    "description":"Paging data transfer object.",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total results"
        }
    }
}

Nested Schema : DmTmUserAssignmentDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmUserAssignmentDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "assignmentCd":{
                    "description":"Assignment Code",
                    "type":"string"
                },
                "assignmentDescr":{
                    "description":"Assignment Description",
                    "type":"string"
                },
                "priority":{
                    "description":"Priority",
                    "type":"integer"
                },
                "productProcessorCd":{
                    "description":"Product Processor Code",
                    "type":"string"
                },
                "groupBasis":{
                    "description":"Group Basis",
                    "type":"string"
                },
                "ignoreGroupBasisFlg":{
                    "description":"Ignore Group Basis Flag",
                    "type":"boolean"
                },
                "assigmentMethodCd":{
                    "description":"Assignment Method Code",
                    "type":"string"
                },
                "effectiveDate":{
                    "description":"Effective Date",
                    "type":"string"
                },
                "expiryDate":{
                    "description":"Expiry Date",
                    "type":"string"
                },
                "ruleCd":{
                    "description":"Rule Code",
                    "type":"string"
                },
                "DmTmUserAssignmentGroupsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmUserAssignmentGroupsDTO"
                    }
                },
                "specialFlg":{
                    "description":"Specialised Flag",
                    "type":"boolean"
                }
            }
        }
    ]
}

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

Type: object

Show Source

assigmentMethodCd: string

Assignment Method Code
assignmentCd: string

Assignment Code
assignmentDescr: string

Assignment Description
DmTmUserAssignmentGroupsDTO: array DmTmUserAssignmentGroupsDTO
effectiveDate: string

Effective Date
expiryDate: string

Expiry Date
groupBasis: string

Group Basis
ignoreGroupBasisFlg: boolean

Ignore Group Basis Flag
priority: integer

Priority
productProcessorCd: string

Product Processor Code
ruleCd: string

Rule Code
specialFlg: boolean

Specialised Flag

{
    "type":"object",
    "properties":{
        "assignmentCd":{
            "description":"Assignment Code",
            "type":"string"
        },
        "assignmentDescr":{
            "description":"Assignment Description",
            "type":"string"
        },
        "priority":{
            "description":"Priority",
            "type":"integer"
        },
        "productProcessorCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "groupBasis":{
            "description":"Group Basis",
            "type":"string"
        },
        "ignoreGroupBasisFlg":{
            "description":"Ignore Group Basis Flag",
            "type":"boolean"
        },
        "assigmentMethodCd":{
            "description":"Assignment Method Code",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective Date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry Date",
            "type":"string"
        },
        "ruleCd":{
            "description":"Rule Code",
            "type":"string"
        },
        "DmTmUserAssignmentGroupsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmUserAssignmentGroupsDTO"
            }
        },
        "specialFlg":{
            "description":"Specialised Flag",
            "type":"boolean"
        }
    }
}

Nested Schema : DmTmUserAssignmentGroupsDTO

Type: array

Show Source

Array of: object DmTmUserAssignmentGroupsDTO

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

Nested Schema : DmTmUserAssignmentGroupsDTO

Type: object

Show Source

activeFlg: boolean

Active Flag
id: string

ID of the User Group
userAssignmentMasterId: string

ID of the User Assignment
userGroupCd: string

User Group Code

{
    "type":"object",
    "properties":{
        "userGroupCd":{
            "description":"User Group Code",
            "type":"string"
        },
        "activeFlg":{
            "description":"Active Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID of the User Group"
        },
        "userAssignmentMasterId":{
            "type":"string",
            "description":"ID of the User Assignment"
        }
    }
}

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