Skip to content

Submission JSON

jcadam14 edited this page Oct 29, 2024 · 30 revisions

NOTE FOR THE FRONTEND: record_no is indexed by 1, with 1 being the first entry in a SBLAR, 2 being the second, etc. This does not line up with the concept of "row number" as would be seen in Excel, where the headers would be row 1. Therefore, add 1 to the record_no to get the 'row', as defined by our program.

{
    "id": 14,
    "counter": 2,
    "state": "SUBMISSION_ACCEPTED",
    "validation_ruleset_version": "0.1.0",
    "validation_results":
        {
            #If there are syntax_errors, there will NOT be any logical errors/warnings
            #If there are logic_errors/warnings, the syntax_errors will be a 0 count with an empty array
            #If there are no errors/warnings, the syntax_errors, logic_errors, and logic_warnings will be 0 with empty array
            "syntax_errors": {
                "single_field_count": 3,
                "multi_field_count": 0, #this will always be zero for syntax errors
                "register_count": 0, #this will always be zero for syntax errors
                "details": [
                    {
                        "validation": {
                            "id": "E0080",
                            "name": "ct_credit_product.invalid_enum_value",
                            "description": "* 'Credit product' must equal 1, 2, 3, 4, 5, 6, 7, 8, 977, or 988.",
                            "severity": "Error",
                            "scope": "single-field",
                            "fig_link": "https://www.consumerfinance.gov/data-research/small-business-lending/filing-instructions-guide/2024-guide/#4.1.6",
                            "is_truncated": true
                        },
                        "records": [
                            {
                                "record_no": 14,
                                "uid": "000TESTFIUIDDONOTUSEXBXVID51XTC1",
                                "fields": [
                                    {
                                        "name": "ct_credit_product",
                                        "value": ""
                                    }
                                ]
                            },
                            {
                                "record_no": 15,
                                "uid": "000TESTFIUIDDONOTUSEXBXVID51XTC2",
                                "fields": [
                                    {
                                        "name": "ct_credit_product",
                                        "value": "9001"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "validation": {
                            "id": "E0120",
                            "name": "ct_guarantee.invalid_enum_value",
                            "description": "* Each value in 'type of guarantee' (separated by semicolons) \nmust equal 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 977, or 999.\n",
                            "severity": "Error",
                            "scope": "single-field",
                            "fig_link": "https://www.consumerfinance.gov/data-research/small-business-lending/filing-instructions-guide/2024-guide/#4.1.7",
                            "is_truncated": false
                        },
                        "records": [
                            {
                                "record_no": 19,
                                "uid": "000TESTFIUIDDONOTUSEXBXVID71XTC1",
                                "fields": [
                                    {
                                        "name": "ct_guarantee",
                                        "value": "9001"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "logic_errors": {
                "single_field_count": 0,
                "multi_field_count": 1,
                "register_count": 2,
                "details": [
                    {
                        "validation": {
                            "id": "E2007",
                            "name": "amount_applied_for.conditional_field_conflict",
                            "description": "* When 'amount applied for: NA/NP flag' does **not** equal \n900 (applicable and reported), 'amount applied for' must be blank.\n* When 'amount applied for: NA/NP flag' equals 900, \n'amount applied for' must **not** be blank.\n",
                            "severity": "Error",
                            "scope": "multi-field",
                            "fig_link": "https://www.consumerfinance.gov/data-research/small-business-lending/filing-instructions-guide/2024-guide/#4.1.8",
                            "is_truncated": true
                        },
                        "records": [
                            {
                                "record_no": 8,
                                "uid": "123456789TESTBANK12300026",
                                "fields": [
                                    {
                                        "name": "amount_applied_for",
                                        "value": ""
                                    },
                                    {
                                        "name": "amount_applied_for_flag",
                                        "value": "900"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "validation": {
                            "id": "E3000",
                            "name": "uid.duplicates_in_dataset",
                            "description": "* Any 'unique identifier' may **not** be used in more than one \nrecord within a small business lending application register.\n",
                            "severity": "Error",
                            "scope": "register",
                            "fig_link": "https://www.consumerfinance.gov/data-research/small-business-lending/filing-instructions-guide/2024-guide/#4.1.9",
                            "is_truncated": false
                        },
                        "records": [
                            {
                                "record_no": 65,
                                "uid": "123456789TESTBANK12300090",
                                "fields": [
                                    {
                                        "name": "uid",
                                        "value": "123456789TESTBANK12300090"
                                    }
                                ]
                            },
                            {
                                "record_no": 66,
                                "uid": "123456789TESTBANK12300090",
                                "fields": [
                                    {
                                        "name": "uid",
                                        "value": "123456789TESTBANK12300090"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "logic_warnings": {
                "single_field_count": 2,
                "multi_field_count": 0,
                "register_count": 0,
                "details": [
                    {
                        "validation": {
                            "id": "W0003",
                            "name": "uid.invalid_uid_lei",
                            "description": "* The first 20 characters of the 'unique identifier' should\nmatch the Legal Entity Identifier (LEI) for the financial institution.\n",
                            "severity": "Warning",
                            "scope": "single-field"
                        },
                        "records": [
                            {
                                "record_no": 1,
                                "uid": "000TESTFIUIDDONOTUSEXGXVID11XTC1",
                                "fields": [
                                    {
                                        "name": "uid",
                                        "value": "000TESTFIUIDDONOTUSEXGXVID11XTC1"
                                    }
                                ]
                            },
                            {
                                "record_no": 2,
                                "uid": "000TESTFIUIDDONOTUSEXGXVID12XTC1",
                                "fields": [
                                    {
                                        "name": "uid",
                                        "value": "000TESTFIUIDDONOTUSEXGXVID12XTC1"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        },
    "filename": "sbl-validations-pass_small.csv",
    "total_records": 3,
    "submitter": {
        "id": 2,
        "user_id": "ABCD-EFGH-1234-5678",
        "user_name": "Test User",
        "user_email": "[email protected]",
        "timestamp": "2024-04-10T05:00:00",
        "action_type": "SUBMIT"
    },
    "accepter": {
        "id": 3,
        "user_id": "ABCD-EFGH-1234-5678",
        "user_name": "Test User",
        "user_email": "[email protected]",
        "timestamp": "2024-04-10T10:00:00",
        "action_type": "ACCEPT"
    }
}
Clone this wiki locally