Sign in
ExamTemplate

Get a page of the specific domain entity. Sorting and filtering is applied before paging

Changed on

Sorting: the sort parameter to sort the list of entities before paging the sort parameter is the name of the entity-model attribute to sort with a leading '-' sign for descending sort order. Note that not all entity-model attribute are suited for sorting while the most are.

</p> Filter: The filter attributes accepted by this API depend on the actual entity model (domain object) and are of the form [domain-attribute-name]=[filter-value]. E.g.: name=abc or type=EXAM. Usually filter attributes of text type are treated as SQL wildcard with %[text]% to filter all text containing a given text-snippet.
get/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)

Query parameters

page_numberinteger

The number of the page to get from the whole list. If the page does not exists, the API retruns with the first page.

page_sizeinteger

The size of the page to get.

sortstring

the sort parameter to sort the list of entities before paging

institutionIdinteger

The institution identifier of the request. Default is the institution identifier of the institution of the current user

namestring

Filters exam templates by name.

examTypestring

Filters exam templates by exam type.

Response

OK

number_of_pagesinteger

The number of available pages for the specified page size.

page_numberinteger

The actual page number. Starting with 1.

page_sizeinteger

The the actual size of a page

sortstring

The page sort column name

completeboolean

Example response

{
  "content": [
    {
      "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 response property // became optional for the status

    • info

      api tag ExamTemplate added

    • info

      api tag exam-template-controller removed

    • info

      added the new optional query request parameter examType

    • info

      added the new optional query request parameter name

    • 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