Jump to

• Request
• Response

Fetch the reconciliation categories based on given parameters

get

/service/v1/reconAttributes

This endpoint fetches reconciliation categories based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• allocationApplicable(optional): string
  Allocation Applicable
• language(optional): string
  Language
• reconCategory: string
  Recon Category
• ruleType: string
  Rule Type

Header Parameters

• appId: string
  App Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : ReconEntityAttributesResponseDto

Type: object

Show Source

• category(optional): string
  Category
• exactAttributes(optional): object ExactAttributesDto
• genericAttributes(optional): object GenericAttributesDto

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"Category"
        },
        "exactAttributes":{
            "$ref":"#/definitions/ExactAttributesDto"
        },
        "genericAttributes":{
            "$ref":"#/definitions/GenericAttributesDto"
        }
    }
}

Nested Schema : ExactAttributesDto

Type: object

Show Source

• lhsEntityAttrs(optional): object EntityAttributesDto
• rhsEntityAttrs(optional): object EntityAttributesDto

{
    "type":"object",
    "properties":{
        "lhsEntityAttrs":{
            "$ref":"#/definitions/EntityAttributesDto"
        },
        "rhsEntityAttrs":{
            "$ref":"#/definitions/EntityAttributesDto"
        }
    }
}

Nested Schema : GenericAttributesDto

Type: object

Show Source

• baseEntity(optional): string
  Base Entity
• criterias(optional): array criterias

{
    "type":"object",
    "properties":{
        "baseEntity":{
            "type":"string",
            "description":"Base Entity"
        },
        "criterias":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CriteriaAttributesDto"
            }
        }
    }
}

Nested Schema : EntityAttributesDto

Type: object

Show Source

• attributes(optional): array attributes
• entityName(optional): string
  Entity Name

{
    "type":"object",
    "properties":{
        "entityName":{
            "type":"string",
            "description":"Entity Name"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttributesDto"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object AttributesDto

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

Nested Schema : AttributesDto

Type: object

Show Source

• allocationApplicable(optional): string
  Allocation Applicable
• attributeDesc(optional): string
  Attribute Description
• attributeName(optional): string
  Attribute Name
• attributeTableName(optional): string
  Attribute Table Name
• attributeType(optional): string
  Attribute Type
• businessAttribute(optional): string
  Business Attribute
• reconAttrMethod(optional): string
  Recon Attribute Method
• reconAttrName(optional): string
  Recon Attribute Name

{
    "type":"object",
    "properties":{
        "attributeName":{
            "type":"string",
            "description":"Attribute Name"
        },
        "attributeDesc":{
            "type":"string",
            "description":"Attribute Description"
        },
        "allocationApplicable":{
            "type":"string",
            "description":"Allocation Applicable"
        },
        "businessAttribute":{
            "type":"string",
            "description":"Business Attribute"
        },
        "reconAttrMethod":{
            "type":"string",
            "description":"Recon Attribute Method"
        },
        "reconAttrName":{
            "type":"string",
            "description":"Recon Attribute Name"
        },
        "attributeType":{
            "type":"string",
            "description":"Attribute Type"
        },
        "attributeTableName":{
            "type":"string",
            "description":"Attribute Table Name"
        }
    }
}

Nested Schema : criterias

Type: array

Show Source

• Array of: object CriteriaAttributesDto

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

Nested Schema : CriteriaAttributesDto

Type: object

Show Source

• attributes(optional): array attributes
• criteriaName(optional): string
  Criteria Name

{
    "type":"object",
    "properties":{
        "criteriaName":{
            "type":"string",
            "description":"Criteria Name"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttributesDto"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object AttributesDto

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

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