Uploaded image for project: 'Ed-Fi Data Standard'
  1. Ed-Fi Data Standard
  2. DATASTD-1175

Require namespaces for descriptors for all API transactions, and require them in a structured format

    XMLWordPrintable

Details

    Description

      The object is to ensure that all descriptors have namespaces in transit, and not to rely on an implied operational context. This is important to ensuring that the semantics of all messages are clear in transit and to communicating information about who governs the values being sent for controlled vocabularies.

      The namespace must look as follows:

      • uri://[org indicator]/[name of descriptor]#[value]

      Example: uri://ed-fi.org/AcademicSubjectDescriptor#Chemistry

      Implementation details:

      • valid namespace format is: [scheme]://[organization name]/[descriptor name]
      • valid scheme is always 'uri'
      • valid organization names can only contain alphanumeric and $-_.+!*'(),
      • valid descriptor name can only contain alphanumeric
      • valid code value can contain anything except '#'

      Attachments

        Activity

          People

            Unassigned Unassigned
            Eric.Jansson Eric Jansson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Salesforce