Uploaded image for project: 'Teacher Preparation Data Model'
  1. Teacher Preparation Data Model
  2. TPDMX-252

Optional/required discrepancies around Credential in TPDM 1.0

    XMLWordPrintable

Details

    • Bug
    • Resolution: Not A Bug
    • Major
    • None
    • TPDM v1.0.0
    • Credentials
    • None

    Description

      UConn developers have raised the following question.  They have been attempting to use core Credential JSON payloads in an ODS/API installation with TPDM 1.0, and they're receiving errors that various elements are required, when they are listed as optional below, along with the additional affirmation that "Credentials can be used as before, as associated with Staff, and without using the added extensions."

      https://techdocs.ed-fi.org/display/TPDMX/Credential+Domain

      1.0 MetaEd does define elements like CertificationTitle and references to Person as required.

      Details below:

      -------------------

      When loading the Credential resource via the API, the following error messaged is received:

      { "message": "Validation of 'Credential' failed.\r\n\tValidation of 'Extensions' failed.\n\t\tCredentialExtension (TPDM): CertificationTitle is required.\n\t\tCredentialExtension (TPDM): PersonId is required.\n\t\tCredentialExtension (TPDM): SourceSystemDescriptorId is required.\n" }

      The use case does not need the Credential extension, it is solely dependent on the edfi.Credential table.

      The documentation in Tech Docs states “Credentials can be used as before, as associated with Staff, and without using the added extensions.”

      Why is the extension a requirement to load the core Credential table if the extensions are not needed on the TPDM 1.0 ODS/API?

      See JSON payload below that was used:
      {
      "credentialIdentifier": "1002",
      "stateOfIssueStateAbbreviationDescriptor": "uri://ed-fi.org/StateAbbreviationDescriptor#CT",
      "credentialFieldDescriptor": "uri://ed-fi.org/CredentialFieldDescriptor#Generalist",
      "credentialTypeDescriptor": "uri://ed-fi.org/CredentialTypeDescriptor#Endorsement",
      "effectiveDate": "2020-11-18",
      "expirationDate": "2022-11-18",
      "issuanceDate": "2020-10-18",
      "namespace": "uri://tpdm.ed-fi.org",
      "teachingCredentialBasisDescriptor": "uri://ed-fi.org/TeachingCredentialBasisDescriptor#Relevant experience",
      "teachingCredentialDescriptor": "uri://ed-fi.org/TeachingCredentialDescriptor#Other",
      "academicSubjects": [

      { "academicSubjectDescriptor": "uri://ed-fi.org/AcademicSubjectDescriptor#Other" }

      ],
      "endorsements": [

      { "credentialEndorsement": "1002 Endorsement" }

      ],
      "gradeLevels": [

      { "gradeLevelDescriptor": "uri://ed-fi.org/GradeLevelDescriptor#Other" }

      ]
      }

      Attachments

        Activity

          People

            Unassigned Unassigned
            siffalo Mark Reichert
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Salesforce