GET //v1/requests/<requestId>/actions/<actionId>/required_documents_status
get status for document requirements for action

Examples

Required Documents calculated successfully
GET v1/requests/1172254/actions/39388/required_documents_status
{
  "message": "required documents retrieval successful",
  "result": [
    {
      "documentTypeId": 2,
      "documentType": "PI CV",
      "displayDocumentType": "PI CV (2 pages limit)",
      "hardPageLimit": 2,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 3,
      "documentType": "CoPI CV",
      "displayDocumentType": "CoPI CV",
      "hardPageLimit": 2,
      "allowMany": true,
      "requirementMet": false,
      "message": "There must be a CoPI CV document for each CoPI."
    },
    {
      "documentTypeId": 1,
      "documentType": "Main Document",
      "displayDocumentType": "Main Document",
      "hardPageLimit": 15,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 4,
      "documentType": "Progress Report",
      "displayDocumentType": "Progress Report",
      "hardPageLimit": 3,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    },
    {
      "documentTypeId": 7,
      "documentType": "Code Perf \u0026 Scaling",
      "displayDocumentType": "Code Perf \u0026 Scaling",
      "hardPageLimit": 5,
      "allowMany": false,
      "requirementMet": true,
      "message": "Requirement Met"
    }
  ]
}

Invalid action failure
GET v1/requests/1172254/actions/393880/required_documents_status
{
  "message": "actionID=393880 not found for this allocations process",
  "result": null
}

Params

Param name	Description
requestId optional	Validations: Must be a Integer
actionId optional	Validations: Must be a Integer

Returns

Code: 200

Description:

OK

Param name	Description
documentTypeId required	Validations: Must be a Integer
documentType required	Validations: Must be a String
displayDocumentType required	Validations: Must be a String
hardPageLimit required	Validations: Must be a Integer
allowMany required	Validations: Must be one of: true, false.
requirementMet required	Validations: Must be one of: true, false.
message required	Validations: Must be a String