Jump to

• Request
• Response

Fetch the Reconciliation rule details

get

/service/v1/getReconRuleDetails

This endpoint fetches Reconciliation rule details based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  authStatus
• partyId(optional): string
  partyId
• reconCategory(optional): string
• reconType(optional): string
• recordStat(optional): string
  recordStatus
• ruleDescription(optional): string
• ruleId(optional): string

Header Parameters

• appId: string
  appId
• branchCode: string
  branchCode
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully received all Recon Rule details

Headers

• Location: string
  Location

Body ()

Root Schema : ScfReconGetDetailsDTO

Type: object

Show Source

• action(optional): string
  Action
• authStat(optional): string
  Authorization Status
• modNo(optional): integer
  Mod Number
• partyId(optional): string
  Party Id
• ReconRuleMasterList(optional): array ReconRuleMasterList
• recordStat(optional): string
  Record Status

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "recordStat":{
            "type":"string",
            "description":"Record Status"
        },
        "authStat":{
            "type":"string",
            "description":"Authorization Status"
        },
        "modNo":{
            "type":"integer",
            "description":"Mod Number"
        },
        "ReconRuleMasterList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfReconRuleDefinitionCollection"
            }
        }
    }
}

Nested Schema : ReconRuleMasterList

Type: array

Show Source

• Array of: object ScfReconRuleDefinitionCollection
  Collection of reconruledefinition.

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

Nested Schema : ScfReconRuleDefinitionCollection

Type: object

Collection of reconruledefinition.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object ReconRuleDefinitionDetailsDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : ReconRuleDefinitionDetailsDTO

Type: object

Show Source

• allocationBasis(optional): string
  Allocation Basis
• baseEntity(optional): string
  Base Entity
• baseOnAttr(optional): string
  Base on Atrribute
• executeGeneric(optional): string
  Execute Generic
• genericCriteria(optional): string
  Generic Criteria
• groupsAndConditions(optional): array groupsAndConditions
• id(optional): string
  Id
• priority(optional): number
  Priority
• reconAllocationDTO(optional): array reconAllocationDTO
• reconCategory(optional): string
  Recon Category
• reconType(optional): string
  Recon Type
• ruleDescription(optional): string
  Rule Description
• ruleId(optional): string
  Rule Id
• rulePartyLinkageFlag(optional): string
  Rule party mapping

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "reconCategory":{
            "type":"string",
            "description":"Recon Category"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule Id"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule Description"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        },
        "executeGeneric":{
            "type":"string",
            "description":"Execute Generic"
        },
        "reconType":{
            "type":"string",
            "description":"Recon Type"
        },
        "genericCriteria":{
            "type":"string",
            "description":"Generic Criteria"
        },
        "baseEntity":{
            "type":"string",
            "description":"Base Entity"
        },
        "baseOnAttr":{
            "type":"string",
            "description":"Base on Atrribute"
        },
        "allocationBasis":{
            "type":"string",
            "description":"Allocation Basis"
        },
        "rulePartyLinkageFlag":{
            "type":"string",
            "description":"Rule party mapping"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleElementDetailsDTO"
            }
        },
        "reconAllocationDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconAllocationDetailsDTO"
            }
        }
    }
}

Nested Schema : groupsAndConditions

Type: array

Show Source

• Array of: object RuleElementDetailsDTO

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

Nested Schema : reconAllocationDTO

Type: array

Show Source

• Array of: object ReconAllocationDetailsDTO

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

Nested Schema : RuleElementDetailsDTO

Type: object

Show Source

• caseSensitive(optional): boolean
  Default Value: false

  Boolean value to identify whether this condition is case sensitive
• connectingOperator(optional): string
  Logical Operator applied between all groups, this is the connecting operator
• groupsAndConditions(optional): array groupsAndConditions
• id(optional): string
  Unique identifier for a group or condition
• isGroup(optional): boolean
  Boolean value to identify whether this child is a group or condition
• level(optional): number
  This helps to identify the nesting level.
• matchingCriteria(optional): string
  Matching Criteria
• patternTypeLHS(optional): object PatternTypeDTO
• patternTypeRHS(optional): object PatternTypeDTO
• reconEntityAttribLHS(optional): string
  Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityAttribRHS(optional): string
  Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityLHS(optional): string
  Should be null or not present if isGroup is true
• reconEntityRHS(optional): string
  Should be null or not present if isGroup is true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a group or condition"
        },
        "caseSensitive":{
            "type":"boolean",
            "description":"Boolean value to identify whether this condition is case sensitive",
            "default":false
        },
        "isGroup":{
            "type":"boolean",
            "description":"Boolean value to identify whether this child is a group or condition"
        },
        "connectingOperator":{
            "type":"string",
            "description":"Logical Operator applied between all groups, this is the connecting operator"
        },
        "level":{
            "type":"number",
            "description":"This helps to identify the nesting level."
        },
        "matchingCriteria":{
            "type":"string",
            "description":"Matching Criteria"
        },
        "reconEntityLHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribLHS":{
            "type":"string",
            "description":"Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "reconEntityRHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribRHS":{
            "type":"string",
            "description":"Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "patternTypeLHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "patternTypeRHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleElementDetailsDTO"
            }
        }
    }
}

Nested Schema : groupsAndConditions

Type: array

Show Source

• Array of: object RuleElementDetailsDTO

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

Nested Schema : PatternTypeDTO

Type: object

Show Source

• inputValue1(optional): string
  Input Value1
• inputValue2(optional): string
  Input Value2
• type(optional): string
  Type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type"
        },
        "inputValue1":{
            "type":"string",
            "description":"Input Value1"
        },
        "inputValue2":{
            "type":"string",
            "description":"Input Value2"
        }
    }
}

Nested Schema : ReconAllocationDetailsDTO

Type: object

Show Source

• action(optional): string
  Action
• allocationParameter(optional): string
  Allocation Parameter
• id(optional): string
  Id
• percentage(optional): number
  Percentage
• reconRuleDefinitionId(optional): string
  Recon Rule Definition Id

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "allocationParameter":{
            "type":"string",
            "description":"Allocation Parameter"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage"
        },
        "reconRuleDefinitionId":{
            "type":"string",
            "description":"Recon Rule Definition Id"
        }
    }
}

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