Jump to

• Request
• Response

Update Existing Risk Indicator

put

/DmRiskIndicator-service/riskIndicators

This endpoint is used to update an existing risk indicator.

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.

Body ()

Request Body that contains data required for updating an existing Risk Indicator.

Root Schema : DmFeedRiskIndicatorWrapperDTO

Type: object

Collection of Risk Indicators medels.

Show Source

• acctNbr: string
  Account Number.
• custNbr: string
  Customer Number.
• prdProcessrCd: string
  Product Processor Code.
• riskIndicator: array riskIndicator

{
    "description":"Collection of Risk Indicators medels.",
    "type":"object",
    "properties":{
        "acctNbr":{
            "description":"Account Number.",
            "type":"string"
        },
        "custNbr":{
            "description":"Customer Number.",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code.",
            "type":"string"
        },
        "riskIndicator":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmFeedRiskIndicatorDTO"
            }
        }
    }
}

Nested Schema : riskIndicator

Type: array

Show Source

• Array of: object DmFeedRiskIndicatorDTO
  Risk Indicator Object

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

Nested Schema : DmFeedRiskIndicatorDTO

Type: object

Risk Indicator Object

Show Source

• entityId: string
  Entity Id
• entityType: string
  Entity Type
• prdProcessrCd: string
  Product Processor Code
• rcdType: string
  Record type
• udf1: number
  udf1
• udf10: number
  udf10
• udf11: number
  udf11
• udf12: number
  udf12
• udf13: number
  udf13
• udf14: number
  udf14
• udf15: number
  udf15
• udf16: number
  udf16
• udf17: number
  udf17
• udf18: number
  udf18
• udf19: number
  udf19
• udf2: number
  udf2
• udf20: number
  udf20
• udf21: number
  udf21
• udf22: number
  udf22
• udf23: number
  udf23
• udf24: number
  udf24
• udf25: number
  udf25
• udf26: number
  udf26
• udf27: number
  udf27
• udf28: number
  udf28
• udf29: number
  udf29
• udf3: number
  udf3
• udf30: number
  udf30
• udf31: string
  udf31
• udf32: string
  udf32
• udf33: string
  udf33
• udf34: string
  udf34
• udf35: string
  udf35
• udf36: string
  udf36
• udf37: string
  udf37
• udf38: string
  udf38
• udf39: string
  udf39
• udf4: number
  udf4
• udf40: string
  udf40
• udf41: string
  udf41
• udf42: string
  udf42
• udf43: string
  udf43
• udf44: string
  udf44
• udf45: string
  udf45
• udf46: string
  udf46
• udf47: string
  udf47
• udf48: string
  udf48
• udf49: string
  udf49
• udf5: number
  udf5
• udf50: string
  udf50
• udf6: number
  udf6
• udf7: number
  udf7
• udf8: number
  udf8
• udf9: number
  udf9
• warnIndCd: string
  Risk Indicator Code
• warnIndVal: string
  Risk Indicator Value

{
    "description":"Risk Indicator Object",
    "type":"object",
    "properties":{
        "entityId":{
            "description":"Entity Id",
            "type":"string"
        },
        "entityType":{
            "description":"Entity Type",
            "type":"string"
        },
        "warnIndCd":{
            "description":"Risk Indicator Code",
            "type":"string"
        },
        "rcdType":{
            "description":"Record type",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "warnIndVal":{
            "description":"Risk Indicator Value",
            "type":"string"
        },
        "udf1":{
            "description":"udf1",
            "type":"number"
        },
        "udf2":{
            "description":"udf2",
            "type":"number"
        },
        "udf3":{
            "description":"udf3",
            "type":"number"
        },
        "udf4":{
            "description":"udf4",
            "type":"number"
        },
        "udf5":{
            "description":"udf5",
            "type":"number"
        },
        "udf6":{
            "description":"udf6",
            "type":"number"
        },
        "udf7":{
            "description":"udf7",
            "type":"number"
        },
        "udf8":{
            "description":"udf8",
            "type":"number"
        },
        "udf9":{
            "description":"udf9",
            "type":"number"
        },
        "udf10":{
            "description":"udf10",
            "type":"number"
        },
        "udf11":{
            "description":"udf11",
            "type":"number"
        },
        "udf12":{
            "description":"udf12",
            "type":"number"
        },
        "udf13":{
            "description":"udf13",
            "type":"number"
        },
        "udf14":{
            "description":"udf14",
            "type":"number"
        },
        "udf15":{
            "description":"udf15",
            "type":"number"
        },
        "udf16":{
            "description":"udf16",
            "type":"number"
        },
        "udf17":{
            "description":"udf17",
            "type":"number"
        },
        "udf18":{
            "description":"udf18",
            "type":"number"
        },
        "udf19":{
            "description":"udf19",
            "type":"number"
        },
        "udf20":{
            "description":"udf20",
            "type":"number"
        },
        "udf21":{
            "description":"udf21",
            "type":"number"
        },
        "udf22":{
            "description":"udf22",
            "type":"number"
        },
        "udf23":{
            "description":"udf23",
            "type":"number"
        },
        "udf24":{
            "description":"udf24",
            "type":"number"
        },
        "udf25":{
            "description":"udf25",
            "type":"number"
        },
        "udf26":{
            "description":"udf26",
            "type":"number"
        },
        "udf27":{
            "description":"udf27",
            "type":"number"
        },
        "udf28":{
            "description":"udf28",
            "type":"number"
        },
        "udf29":{
            "description":"udf29",
            "type":"number"
        },
        "udf30":{
            "description":"udf30",
            "type":"number"
        },
        "udf31":{
            "description":"udf31",
            "type":"string"
        },
        "udf32":{
            "description":"udf32",
            "type":"string"
        },
        "udf33":{
            "description":"udf33",
            "type":"string"
        },
        "udf34":{
            "description":"udf34",
            "type":"string"
        },
        "udf35":{
            "description":"udf35",
            "type":"string"
        },
        "udf36":{
            "description":"udf36",
            "type":"string"
        },
        "udf37":{
            "description":"udf37",
            "type":"string"
        },
        "udf38":{
            "description":"udf38",
            "type":"string"
        },
        "udf39":{
            "description":"udf39",
            "type":"string"
        },
        "udf40":{
            "description":"udf40",
            "type":"string"
        },
        "udf41":{
            "description":"udf41",
            "type":"string"
        },
        "udf42":{
            "description":"udf42",
            "type":"string"
        },
        "udf43":{
            "description":"udf43",
            "type":"string"
        },
        "udf44":{
            "description":"udf44",
            "type":"string"
        },
        "udf45":{
            "description":"udf45",
            "type":"string"
        },
        "udf46":{
            "description":"udf46",
            "type":"string"
        },
        "udf47":{
            "description":"udf47",
            "type":"string"
        },
        "udf48":{
            "description":"udf48",
            "type":"string"
        },
        "udf49":{
            "description":"udf49",
            "type":"string"
        },
        "udf50":{
            "description":"udf50",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

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

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

{
    "description":"Collection of Notes.",
    "type":"object",
    "properties":{
        "notesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NotesModel"
            }
        }
    }
}

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case Id",
            "type":"string"
        }
    }
}

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