Learning and Development - Batch

Field descriptions

Copy
{
  "id": { "type": "string" }, // (Required) Unique identifier for the data
  "credentials": [ // { "type": "array" }, (Required) Array of microcredential data
    {
      "id": { "type": "string" }, // (Required) Unique identifier for this batch item
      "credential_type": { "type": "string" }, // (Required) Must be "microcredential"
      "document_type": { "type": "string" }, // (Required) Must be one of "pdf", "open_cert", or "none"
      "data": { // { "type": "object" }, (Required)
        "credential": { { "type": "object" }, (Required)
          "full_name": { "type": "string" }, // (Required)
          "issuer_name": { "type": "string" }, // (Required)
          "microcredential_name": { "type": "string" }, // (Required)
          "issue_date": { "type": "string" }, // (Required) Date format: "YYYY-MM-DD"
          "expiry_date": { "type": "string" }, // (Optional) Date format: "YYYY-MM-DD"
          "assessment_result": { "type": ["string", null] } // (Optional) Text description
        },
        "document": { "type": "string" }, // (Optional) Depending on the supplied document_type, either a URL pointing to a PDF document, the content of an OpenCert document, or null if not applicable.
      }
    }
  ]
}

Sample payload

With PDF document

Copy
{
  "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a",
  "credentials": [
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-1",
      "document_type": "pdf",
      "credential_type": "microcredential",
      "data": {
        "document": "https://example.com/1234.pdf",
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #1",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11",
          "assessment_result": "Pass"
        }
      }
    },
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-2",
      "document_type": "pdf",
      "credential_type": "microcredential",
      "data": {
        "document": "https://example.com/5678.pdf",
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #2",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11"
        }
      }
    }
  ]
}

With OpenCert document

Copy
{
  "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a",
  "credentials": [
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-1",
      "document_type": "open_cert",
      "credential_type": "microcredential",
      "data": {
        "document": "{\"version\":\"https://schema.openattestation.com/2.0/schema.json\",\"schema\":\"https://raw.githubusercontent.com/OpenCerts/open-certificate/master/schema/transcripts/2.0/schema.json\"}",
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #1",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11",
          "assessment_result": "Pass"
        }
      }
    },
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-2",
      "document_type": "open_cert",
      "credential_type": "microcredential",
      "data": {
        "document": "{\"version\":\"https://schema.openattestation.com/2.0/schema.json\",\"schema\":\"https://raw.githubusercontent.com/OpenCerts/open-certificate/master/schema/transcripts/2.0/schema.json\"}",
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #2",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11"
        }
      }
    }
  ]
}

With no document

Copy
{
  "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a",
  "credentials": [
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-1",
      "document_type": "none",
      "credential_type": "microcredential",
      "data": {
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #1",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11"
        }
      }
    },
    {
      "id": "dde1a68d-0ae4-488c-b51c-78a33acf603a-2",
      "document_type": "none",
      "credential_type": "microcredential",
      "data": {
        "credential": {
          "full_name": "Glenn O'Hara DVM",
          "issuer_name": "Test Issuer",
          "microcredential_name": "Skill Test #2",
          "issue_date": "2024-08-31",
          "expiry_date": "2027-06-11"
        }
      }
    }
  ]
}