Rule book action required fields

Returns required fields for an action in an allocation type.

Examples

{
    "message": null,
    "result": {
        "actionTypeId": 5,
        "actionType": "Appeal",
        "allocationTypeId": 500008,
        "allocationType": "SRAC",
        "requiredFields": {
            "request": {
                "abstract": {"required": false},
                "actions": {
                    "allocationDates": {
                        "endDate": {"required": false},
                        "beginDate": {"required": false}
                    },
                    "userComments": {"required": false}
                },
                "isSupportedByGrants": {"required": false},
                "keywords": {"required": false},
                "shortTitle": {"required": false},
                "grants": {
                    "awardedAmount": {"required": false},
                    "comments": {"required": false},
                    "endDate": {"required": false},
                    "fundingAgencyId": {"required": false},
                    "grantNumber": {"required": false},
                    "piName": {"required": false},
                    "percentageAward": {"required": false},
                    "primaryFosTypeId": {"required": false},
                    "programOfficerEmail": {"required": false},
                    "programOfficerName": {"required": false},
                    "beginDate": {"required": false},
                    "title": {"required": false}
                },
                "title": {"required": false},
                "roles": {
                    "person": {
                        "username": {"required": false}
                    }
                }
            }
        }
    }
}

{
    "message": null,
    "result": {
        "actionTypeId": 2,
        "actionType": "New",
        "allocationTypeId": 500013,
        "allocationType": "Startup",
        "requiredFields": {
            "request": {
                "abstract": {
                    "required": true,
                    "errorMessage": "Abstract is a required field"
                },
                "actions": {
                    "allocationDates": {
                        "endDate": {"required": false},
                        "beginDate": {"required": false}
                    },
                    "userComments": {"required": false}
                },
                "isSupportedByGrants": {
                    "required": true,
                    "errorMessage": "Is this project supported by grants question must be answered"
                },
                "keywords": {
                    "required": true,
                    "errorMessage": "Keywords are required"
                },
                "shortTitle": {"required": false},
                "grants": {
                    "awardedAmount": {
                        "required": true,
                        "errorMessage": "Supporting Grant Award Amount is required"
                    },
                    "comments": {"required": false},
                    "endDate": {
                        "required": true,
                        "errorMessage": "Supporting Grant End Date is required"
                    },
                    "fundingAgencyId": {
                        "required": true,
                        "errorMessage": "Supporting Grant Funding Agency is required"
                    },
                    "grantNumber": {
                        "required": true,
                        "errorMessage": "Supporting Grant Grant Number is required"
                    },
                    "piName": {
                        "required": true,
                        "errorMessage": "Supporting Grant PI Name is required"
                    },
                    "percentageAward": {
                        "required": true,
                        "errorMessage": "Supporting Grant Percent of Annual Amount is required"
                    },
                    "primaryFosTypeId": {
                        "required": true,
                        "errorMessage": "Supporting Grant Primary Field of Science is required"
                    },
                    "programOfficerEmail": {
                        "required": true,
                        "errorMessage": "Supporting Grant Program Officer Email is required"
                    },
                    "programOfficerName": {
                        "required": true,
                        "errorMessage": "Supporting Grant Program Officer Name is required"
                    },
                    "beginDate": {
                        "required": true,
                        "errorMessage": "Supporting Grant Begin Date is required"
                    },
                    "title": {
                        "required": true,
                        "errorMessage": "Supporting Grant Title is required"
                    }
                },
                "title": {
                    "required": true,
                    "errorMessage": "Title is a required field"
                },
                "roles": {
                    "person": {
                        "username": {"required": false}
                    }
                }
            }
        }
    }
}

Params

Param name	Description
allocationTypeId required	Validations: Must be a Integer
actionTypeId required	Validations: Must be a Integer

Returns

Code: 200

Description:

OK

Param name	Description
actionTypeId required	Validations: Must be a Integer
actionType required	Validations: Must be a String
allocationTypeId required	Validations: Must be a Integer
allocationType required	Validations: Must be a String
requiredFields required	Validations: Must be a Hash
requiredFields[request] required	Validations: Must be a Hash
requiredFields[request][abstract] required	Validations: Must be a Hash
requiredFields[request][abstract][required] required	Validations: Must be one of: true, false.
requiredFields[request][abstract][errorMessage] required	Validations: Must be a String
requiredFields[request][actions] required	Validations: Must be a Hash
requiredFields[request][actions][allocationDates] required	Validations: Must be a Hash
requiredFields[request][actions][allocationDates][endDate] required	Validations: Must be a Hash
requiredFields[request][actions][allocationDates][endDate][required] required	Validations: Must be one of: true, false.
requiredFields[request][actions][allocationDates][beginDate] required	Validations: Must be a Hash
requiredFields[request][actions][allocationDates][beginDate][required] required	Validations: Must be one of: true, false.
requiredFields[request][actions][userComments] required	Validations: Must be a Hash
requiredFields[request][actions][userComments][required] required	Validations: Must be one of: true, false.
requiredFields[request][isSupportedByGrants] required	Validations: Must be a Hash
requiredFields[request][isSupportedByGrants][required] required	Validations: Must be one of: true, false.
requiredFields[request][isSupportedByGrants][errorMessage] required	Validations: Must be a String
requiredFields[request][keywords] required	Validations: Must be a Hash
requiredFields[request][keywords][required] required	Validations: Must be one of: true, false.
requiredFields[request][keywords][errorMessage] required	Validations: Must be a String
requiredFields[request][shortTitle] required	Validations: Must be a Hash
requiredFields[request][shortTitle][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants] required	Validations: Must be a Hash
requiredFields[request][grants][awardedAmount] required	Validations: Must be a Hash
requiredFields[request][grants][awardedAmount][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][awardedAmount][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][comments] required	Validations: Must be a Hash
requiredFields[request][grants][comments][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][endDate] required	Validations: Must be a Hash
requiredFields[request][grants][endDate][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][endDate][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][fundingAgencyId] required	Validations: Must be a Hash
requiredFields[request][grants][fundingAgencyId][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][fundingAgencyId][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][grantNumber] required	Validations: Must be a Hash
requiredFields[request][grants][grantNumber][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][grantNumber][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][piName] required	Validations: Must be a Hash
requiredFields[request][grants][piName][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][piName][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][percentageAward] required	Validations: Must be a Hash
requiredFields[request][grants][percentageAward][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][percentageAward][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][primaryFosTypeId] required	Validations: Must be a Hash
requiredFields[request][grants][primaryFosTypeId][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][primaryFosTypeId][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][programOfficerEmail] required	Validations: Must be a Hash
requiredFields[request][grants][programOfficerEmail][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][programOfficerEmail][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][programOfficerName] required	Validations: Must be a Hash
requiredFields[request][grants][programOfficerName][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][programOfficerName][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][beginDate] required	Validations: Must be a Hash
requiredFields[request][grants][beginDate][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][beginDate][errorMessage] required	Validations: Must be a String
requiredFields[request][grants][title] required	Validations: Must be a Hash
requiredFields[request][grants][title][required] required	Validations: Must be one of: true, false.
requiredFields[request][grants][title][errorMessage] required	Validations: Must be a String
requiredFields[request][title] required	Validations: Must be a Hash
requiredFields[request][title][required] required	Validations: Must be one of: true, false.
requiredFields[request][title][errorMessage] required	Validations: Must be a String
requiredFields[request][roles] required	Validations: Must be a Hash
requiredFields[request][roles][person] required	Validations: Must be a Hash
requiredFields[request][roles][person][username] required	Validations: Must be a Hash
requiredFields[request][roles][person][username][required] required	Validations: Must be one of: true, false.

Code: 500

Description:

Unconfigured rule book

Param name	Description