Validate FDM

View the OpenAPI specification

This endpoint allows you to validate one or more Foundational Data Model (FDM) combinations. The primary function is to ensure that all the worktags in a combination are allowable with each other. You’ll also be notified about nonexistant worktags and other simple errors.

Request

{
  "data": [
    {
      "type": "fdmCombos",
      "id": "1",
      "attributes": {
        "company": "UWRVF",
        "fund": "FD0233",
        "costCenter": "CC001241",
        "function": "FN0000",
        "gift": "GF000000001"
      }
    },
    {
      "type": "fdmCombos",
      "id": "2",
      "attributes": {
        "company": "UWRVF",
        "fund": "FD0101",
        "costCenter": "CC001241",
        "function": "FN0000",
        "gift": "GF00000001"
      }
    }
  ]
}

Response

{
  "data": [
    {
      "attributes": {
        "errors": [],
        "valid": true
      },
      "id": "1",
      "type": "fdmComboValidationResults"
    },
    {
      "attributes": {
        "errors": [
          "Gift GF00000001 is not valid under company UWRVF."
        ],
        "valid": false
      },
      "id": "2",
      "type": "fdmComboValidationResults"
    }
  ]
}

Validations performed

All values are checked to ensure they correspond to existing values for that object
Worktags that are not allowable for the given driver worktag are flagged
- Note that the set of allowable data entered in the current data source is limited. If allowable worktags have not been configured for a given driver worktag, all worktags will be considered allowable and no error will be returned.
Multiple driver worktags are allowed by this validator. In most real-world usage, you’ll need to use only one driver worktag, but there are some circumstances (eg. cost share grants) where more than one are required.

FDM Validator Error Codes

Validator responses are assigned machine-readable error codes. You can use these to drive further automated behavior.

"data": {
  "attributes": {
    "errors": [
      {
        errorCode: "FDM207",
        errorMessage: "Gift GF00000001 is not valid under company UWRVF."
      }
    ],
    "valid": false
  },
  "id": "2",
  "type": "fdmComboValidationResults"
}

FDM Error Code List

FDM101 – Missing required Company.
FDM102 – Missing required driver worktag.
FDM103 – Too many driver worktags.

FDM201 – Invalid Company.
FDM202 – Invalid Cost Center.
FDM203 – Invalid Fund.
FDM204 – Invalid Function.
FDM205 – Invalid Program.
FDM206 – Invalid Project.
FDM207 – Invalid Gift.
FDM208 – Invalid Grant.
FDM209 – Invalid Spend Category.
FDM210 – Invalid Revenue Category.
FDM211 – Invalid Ledger Account.
FDM212 – Invalid Activity.

FDM301 – Cost Center/Program combination error.
FDM302 – Cost Center/Project combination error.
FDM303 – Cost Center/Gift combination error.
FDM304 – Cost Center/Grant combination error.
FDM305 – Fund/Program combination error.
FDM306 – Fund/Project combination error.
FDM307 – Fund/Gift combination error.
FDM308 – Fund/Grant combination error.
FDM309 – Function/Program combination error.
FDM310 – Function/Project combination error.
FDM311 – Function/Gift combination error.
FDM312 – Function/Grant combination error.
FDM313 – Grant is not a cost share, and cannot be combined with other drivers.
FDM314 – Fund/Project combination error on a cost share.
FDM315 – Fund/Program combination error on a cost share grant.
FDM316 – Fund/Gift combination error on a cost share grant.
FDM317 – Grant is a cost share, so at one additional driver worktag is required.