Institution

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/institution

Request

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

Request body

idinteger

Institution identifier. Omit for creation; assigned by the server.

namestring required

Institution name.

logoImagestring

Base64-encoded institution logo image.

themeNamestring

Name of the visual theme applied for this institution.

activeboolean

Whether the institution is active.

Example request

{
  "name": "ETH Zurich",
  "active": true
}

Response

OK

idinteger

Institution identifier. Omit for creation; assigned by the server.

namestring required

Institution name.

logoImagestring

Base64-encoded institution logo image.

themeNamestring

Name of the visual theme applied for this institution.

activeboolean

Whether the institution is active.

Example response

{
  "name": "ETH Zurich",
  "active": true
}

Changes

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      the request property's maxLength was set to 45

    • info

      api tag Institution added

    • info

      api tag institution-controller removed