ExamTemplate

Modifies an already existing entity object of the specific type.

Changed on

This expects application/json format for the response data and verifies consistencies within the definition of the specific entity object type. Missing (NULL) parameter that are not mandatory will be ignored and the original value will not be affected

put/admin-api/v1/exam-template

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/exam-template
  • Auth: oauth (defined in the document in a form this page cannot read)

Request body

idinteger

Exam template identifier (PK). Not set on create.

institutionIdinteger

Institution identifier the exam template belongs to. Derived from the current user on create; required on update.

namestring required

Unique name of the exam template.

descriptionstring

Free-text description of the exam template.

examType'UNDEFINED' | 'MANAGED' | 'BYOD' | 'VDI'

Exam type preset applied to exams created from this template.

supporterstring[]
configurationTemplateIdinteger

Identifier of the configuration template holding the SEB settings.

institutionalDefaultboolean required

Whether this is the institutional default exam template.

lmsIntegrationboolean required

Whether assessment tool (LMS) integration is enabled for exams created from this template.

clientConfigurationIdinteger

Identifier of the preselected connection configuration.

EXAM_ATTRIBUTESobject required

Additional exam attributes as key-value pairs (enableScreenProctoring, spsCollectingStrategy, spsCollectingGroupName, spsSEBGroupsSelection, quitPassword). Always present.

Example request

{
  "id": 1,
  "institutionId": 1,
  "name": "Semester End BYOD",
  "examType": "BYOD",
  "configurationTemplateId": 4,
  "clientConfigurationId": 1,
  "indicatorTemplates": [
    {
      "id": 1,
      "examTemplateId": 1,
      "name": "Battery",
      "type": "BATTERY_STATUS",
      "color": "44a2c6",
      "thresholds": [
        {
          "value": 50,
          "color": "ff9800"
        }
      ]
    }
  ]
}

Response

OK

idinteger

Exam template identifier (PK). Not set on create.

institutionIdinteger

Institution identifier the exam template belongs to. Derived from the current user on create; required on update.

namestring required

Unique name of the exam template.

descriptionstring

Free-text description of the exam template.

examType'UNDEFINED' | 'MANAGED' | 'BYOD' | 'VDI'

Exam type preset applied to exams created from this template.

supporterstring[]
configurationTemplateIdinteger

Identifier of the configuration template holding the SEB settings.

institutionalDefaultboolean required

Whether this is the institutional default exam template.

lmsIntegrationboolean required

Whether assessment tool (LMS) integration is enabled for exams created from this template.

clientConfigurationIdinteger

Identifier of the preselected connection configuration.

EXAM_ATTRIBUTESobject required

Additional exam attributes as key-value pairs (enableScreenProctoring, spsCollectingStrategy, spsCollectingGroupName, spsSEBGroupsSelection, quitPassword). Always present.

Example response

{
  "id": 1,
  "institutionId": 1,
  "name": "Semester End BYOD",
  "examType": "BYOD",
  "configurationTemplateId": 4,
  "clientConfigurationId": 1,
  "indicatorTemplates": [
    {
      "id": 1,
      "examTemplateId": 1,
      "name": "Battery",
      "type": "BATTERY_STATUS",
      "color": "44a2c6",
      "thresholds": [
        {
          "value": 50,
          "color": "ff9800"
        }
      ]
    }
  ]
}

Changes

  • 307d5ee03c39Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property // became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the response property became optional for the status

    • info

      api tag ExamTemplate added

    • info

      api tag exam-template-controller removed

    • info

      the request property became optional

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 94fd325fcb6cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status