Overview

The API is used for accessing private data related to people.

Endpoints

Delete access role assignments

POST /api/access-roles/v1/{accessRoleId}/person-assignments/delete

Parameters

Path Parameters

Name

Description

Schema

Example

accessRoleId required

Id of the access role the access role person assignment belongs to

String

otm-123456
Body Parameter
Name Description Schema Example

string required

List ([string])

Responses

Table 1. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/access-roles/v1/otm-b4f818ce-15bd-4328-9784-20154bf9ae1a/person-assignments/delete HTTP/1.1
Content-Type: application/json
Content-Length: 46
Authorization: Basic c3BlY3RyZS5pOnRlc3QxMjM=
Host: localhost:8080

[ "otm-6ce311b2-cc6d-4826-8e75-445fa15b46a3" ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Export access roles

GET /api/access-roles/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return access roles modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return access roles modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of access roles to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 2. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultAccessRole[ExportResultAccessRole]
Produces

  • application/json

Samples

GET /api/access-roles/v1/export?since=47681&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 531

{
  "greatestOrdinal" : 47682,
  "hasMore" : false,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "arska",
      "createdOn" : "2024-04-18T12:41:11.225877",
      "lastModifiedBy" : "arska",
      "lastModifiedOn" : "2024-04-18T12:41:11.225894",
      "modificationOrdinal" : 47682
    },
    "documentState" : "ACTIVE",
    "id" : "otm-ac2a9db9-ce9d-43af-aa1f-791caee0a386",
    "name" : {
      "en" : "Test role"
    },
    "permissionUrns" : [ "urn:code:permission:course-unit-admin" ]
  } ]
}

Get access role assignments for access role

GET /api/access-roles/v1/{accessRoleId}/person-assignments

Parameters

Path Parameters

Name

Description

Schema

Example

accessRoleId required

String

otm-123456

Responses

Table 3. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[AccessRolePersonAssignment]
Produces

  • /

Samples

Import access role assignments

POST /api/access-roles-person-assignments/v1/import

Parameters

Body Parameter
Name Description Schema Example

AccessRolePersonAssignment required

List (AccessRolePersonAssignment)

Responses

Table 4. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/access-roles-person-assignments/v1/import HTTP/1.1
Content-Type: application/json
Content-Length: 378
Host: localhost:8080

[ {
  "accessRoleId" : "otm-2872972a-0830-4be2-8764-193ba578392c",
  "id" : "otm-194dff6f-d0ee-404b-9f37-58a8f0278028",
  "accessRoleName" : null,
  "personId" : "otm-ozzi-user",
  "personFirstNames" : null,
  "personLastName" : null,
  "resourceType" : "global",
  "resourceId" : null,
  "validityPeriod" : {
    "startDate" : "2000-01-01",
    "endDate" : "2100-01-01"
  }
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Import access roles

POST /api/access-roles/v1/import

Parameters

Body Parameter
Name Description Schema Example

AccessRole required

List (AccessRole)

Responses

Table 5. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/access-roles/v1/import HTTP/1.1
Content-Type: application/json
Content-Length: 423
Host: localhost:8080

[ {
  "metadata" : {
    "revision" : 1,
    "createdBy" : "arska",
    "createdOn" : "2024-04-18T12:41:11.034872",
    "lastModifiedBy" : "arska",
    "lastModifiedOn" : "2024-04-18T12:41:11.034886",
    "modificationOrdinal" : null
  },
  "documentState" : "ACTIVE",
  "id" : "otm-f25be2e8-c8a1-470b-b3e2-f477de6c3ded",
  "name" : {
    "en" : "Global admins"
  },
  "permissionUrns" : [ "urn:code:permission:admin" ]
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Save access role assignments

POST /api/access-roles/v1/{accessRoleId}/person-assignments

Parameters

Path Parameters

Name

Description

Schema

Example

accessRoleId required

Id of the access role the access role person assignment belongs to

String

otm-123456
Body Parameter
Name Description Schema Example

AccessRolePersonAssignment required

List (AccessRolePersonAssignment)

Responses

Table 6. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[AccessRolePersonAssignment]
Produces

  • /

Samples

POST /api/access-roles/v1/otm-027a1b51-7467-4f04-90fa-1c77652072b4/person-assignments HTTP/1.1
Content-Type: application/json
Content-Length: 712
Authorization: Basic c3BlY3RyZS5pOnRlc3QxMjM=
Host: localhost:8080

[ {
  "accessRoleId" : null,
  "id" : "otm-69bc404b-0b45-4de4-be99-49b8da1777b9",
  "accessRoleName" : null,
  "personId" : "otm-person1",
  "personFirstNames" : null,
  "personLastName" : null,
  "resourceType" : "global",
  "resourceId" : null,
  "validityPeriod" : {
    "startDate" : "2024-04-18",
    "endDate" : "2024-04-19"
  }
}, {
  "accessRoleId" : "otm-b920b641-453b-480e-9e51-8a6948727bbc",
  "id" : "otm-2a27b509-2f93-4980-995e-1e52fdc58d15",
  "accessRoleName" : null,
  "personId" : "otm-person1",
  "personFirstNames" : null,
  "personLastName" : null,
  "resourceType" : "global",
  "resourceId" : null,
  "validityPeriod" : {
    "startDate" : "2024-04-18",
    "endDate" : "2024-04-19"
  }
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 768

[ {
  "accessRoleId" : "otm-027a1b51-7467-4f04-90fa-1c77652072b4",
  "id" : "otm-69bc404b-0b45-4de4-be99-49b8da1777b9",
  "accessRoleName" : null,
  "personId" : "otm-person1",
  "personFirstNames" : "Pekka",
  "personLastName" : "Henkilö",
  "resourceType" : "global",
  "resourceId" : null,
  "validityPeriod" : {
    "startDate" : "2024-04-18",
    "endDate" : "2024-04-19"
  }
}, {
  "accessRoleId" : "otm-027a1b51-7467-4f04-90fa-1c77652072b4",
  "id" : "otm-2a27b509-2f93-4980-995e-1e52fdc58d15",
  "accessRoleName" : null,
  "personId" : "otm-person1",
  "personFirstNames" : "Pekka",
  "personLastName" : "Henkilö",
  "resourceType" : "global",
  "resourceId" : null,
  "validityPeriod" : {
    "startDate" : "2024-04-18",
    "endDate" : "2024-04-19"
  }
} ]

Export application accounts

GET /api/application-accounts/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return application accounts modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return application accounts modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of application accounts to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 7. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultApplicationAccount[ExportResultApplicationAccount]
Produces

  • application/json

Samples

Import application accounts

POST /api/application-accounts/v1/import

Parameters

Body Parameter
Name Description Schema Example

ApplicationAccount required

List (ApplicationAccount)

Responses

Table 8. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export AttainedQualifications

GET /api/attained-qualifications/v1/export

Parameters

Query Parameters
Name Description Schema Example

since optional

Return attained qualifications modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return attained qualifications modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of attained qualifications to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 9. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultAttainedQualification[ExportResultAttainedQualification]
Produces

  • application/json

Samples

Import AttainedQualifications

POST /api/attained-qualifications/v1/import

Parameters

Body Parameter
Name Description Schema Example

AttainedQualification required

List (AttainedQualification)

Responses

Table 10. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Create attainment

POST /api/attainments

Parameters

Body Parameter
Name Description Schema Example

CreateAttainmentRequest required

CreateAttainmentRequest (CreateAttainmentRequest)

Responses

Table 11. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

createAttainment_request[[createAttainment_request]]
Produces

  • application/json

Samples

Export attainments

GET /api/attainments/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return attainments modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return attainments modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of attainments to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 12. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultAttainment[ExportResultAttainment]
Produces

  • application/json

Samples

GET /api/attainments/v1/export?since=0&limit=2 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4400

{
  "greatestOrdinal" : 50881,
  "hasMore" : true,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "spectre.i",
      "createdOn" : "2024-04-18T12:41:24.688875",
      "lastModifiedBy" : "spectre.i",
      "lastModifiedOn" : "2024-04-18T12:41:24.688875",
      "modificationOrdinal" : 50880
    },
    "documentState" : "ACTIVE",
    "id" : "otm-0082caa1-d1a5-4695-ba46-a28cc10e0b90",
    "personId" : "test-esa",
    "personFirstNames" : null,
    "personLastName" : null,
    "personStudentNumber" : null,
    "verifierPersonId" : "otm-person1",
    "studyRightId" : "otm-f21a480d-7eca-4371-870e-1d73d728e906",
    "registrationDate" : "2024-04-18",
    "expiryDate" : null,
    "attainmentLanguageUrn" : "urn:code:language:fi",
    "acceptorPersons" : [ {
      "text" : {
        "fi" : "lokalisoitu kuvaus"
      },
      "personId" : "otm-person1",
      "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
      "title" : null
    }, {
      "text" : {
        "fi" : "lokalisoitu kuvaus"
      },
      "personId" : "otm-person2",
      "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
      "title" : null
    } ],
    "organisations" : [ {
      "organisationId" : "test-organisation1",
      "educationalInstitutionUrn" : null,
      "roleUrn" : "urn:code:organisation-role:responsible-organisation",
      "share" : 1.0
    } ],
    "state" : "ATTAINED",
    "misregistration" : false,
    "misregistrationRationale" : null,
    "primary" : true,
    "credits" : 5.0,
    "studyWeeks" : null,
    "gradeScaleId" : "otm-gs1",
    "gradeId" : 0,
    "gradeAverage" : null,
    "additionalInfo" : null,
    "administrativeNote" : null,
    "studyFieldUrn" : null,
    "workflowId" : null,
    "moduleContentApplicationId" : null,
    "creditTransferInfo" : null,
    "cooperationNetworkStatus" : null,
    "rdiCredits" : null,
    "collaborationInstitution" : null,
    "enrolmentRightId" : null,
    "courseUnitId" : "otm-course-unit-1",
    "assessmentItemId" : "otm-assessment-item-1",
    "courseUnitRealisationId" : "otm-course-unit-realisation-1",
    "attainmentDate" : "2009-02-06",
    "type" : "AssessmentItemAttainment",
    "studentApplicationId" : null
  }, {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "spectre.i",
      "createdOn" : "2024-04-18T12:41:24.688875",
      "lastModifiedBy" : "spectre.i",
      "lastModifiedOn" : "2024-04-18T12:41:24.688875",
      "modificationOrdinal" : 50881
    },
    "documentState" : "ACTIVE",
    "id" : "otm-21d9bf88-8ee7-49be-8d24-0c26c37e8b7c",
    "personId" : "test-eki",
    "personFirstNames" : null,
    "personLastName" : null,
    "personStudentNumber" : null,
    "verifierPersonId" : "otm-person1",
    "studyRightId" : "otm-28727e79-7b9d-481d-beb6-1beb8a401aad",
    "registrationDate" : "2024-04-18",
    "expiryDate" : null,
    "attainmentLanguageUrn" : "urn:code:language:fi",
    "acceptorPersons" : [ {
      "text" : {
        "fi" : "lokalisoitu kuvaus"
      },
      "personId" : "otm-person1",
      "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
      "title" : null
    }, {
      "text" : {
        "fi" : "lokalisoitu kuvaus"
      },
      "personId" : "otm-person2",
      "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
      "title" : null
    } ],
    "organisations" : [ {
      "organisationId" : "test-organisation1",
      "educationalInstitutionUrn" : null,
      "roleUrn" : "urn:code:organisation-role:responsible-organisation",
      "share" : 1.0
    } ],
    "state" : "ATTAINED",
    "misregistration" : false,
    "misregistrationRationale" : null,
    "primary" : true,
    "credits" : 5.0,
    "studyWeeks" : null,
    "gradeScaleId" : "otm-gs1",
    "gradeId" : 0,
    "gradeAverage" : null,
    "additionalInfo" : null,
    "administrativeNote" : null,
    "studyFieldUrn" : null,
    "workflowId" : null,
    "moduleContentApplicationId" : null,
    "creditTransferInfo" : null,
    "cooperationNetworkStatus" : null,
    "rdiCredits" : null,
    "collaborationInstitution" : null,
    "enrolmentRightId" : null,
    "courseUnitId" : "otm-course-unit-1",
    "assessmentItemId" : "otm-assessment-item-1",
    "courseUnitRealisationId" : "otm-course-unit-realisation-1",
    "attainmentDate" : "2024-04-17",
    "type" : "AssessmentItemAttainment",
    "studentApplicationId" : null
  } ]
}

Get attainments

GET /api/attainments

Get by attainment ids, person id, or course unit realisation id

Parameters

Query Parameters
Name Description Schema Example

id optional

Identifiers for the attainments to find

Set ([String])

personId optional

Identifier for the person for whom the attainments will be returned

String

personId_example

courseUnitRealisationId optional

Identifier for the course unit realisation for which the attainments will be returned

String

courseUnitRealisationId_example

includeDrafts optional

Includes attainments with documentState:'draft' to response (used only with 'personId' -param request)

Boolean

true

Responses

Table 13. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[[getAttainments_200_response_inner]]
Produces

  • application/json

Samples

Get attainments for person

GET /api/attainments/v1/for-person

Get all attainments by person id, excluding DELETED attainments.

Parameters

Query Parameters
Name Description Schema Example

personId required

String

otm-123456

Responses

Table 14. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[[createAttainment_request]]
Produces

  • application/json

Samples

Import attainments

POST /api/attainments/v1/import

Referred attainments must precede the referring attainments. So, if you have a course unit attainment with some assessment item attainment ids, the latter must come first in the import data. Course unit attainments can only refer to assessment item attainments. Module attainments and degree programme attainments cannot refer to assessment item attainments.

Parameters

Body Parameter
Name Description Schema Example

createAttainment_request required

List ([createAttainment_request])
Query Parameters
Name Description Schema Example

resolvePrimary optional

When true and attainment.primary is set to false, resolve primary attainment with highest credits and/or grade.

Boolean

true

courseUnitReEvaluate optional

When true, each attached course unit attainment of imported assessment item attainments is checked for re-evaluation.

Boolean

true

Responses

Table 15. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/attainments/v1/import HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 3622
Host: localhost:8080

[ {
  "metadata" : null,
  "documentState" : "ACTIVE",
  "id" : "otm-0fe7f59c-b53f-44ef-90fc-33cd66bc94f0",
  "personId" : "test-eki",
  "personFirstNames" : null,
  "personLastName" : null,
  "personStudentNumber" : null,
  "verifierPersonId" : "otm-person1",
  "studyRightId" : "otm-d643cb48-c5f2-47aa-93b2-4492ab637363",
  "registrationDate" : "2024-04-18",
  "expiryDate" : null,
  "attainmentLanguageUrn" : "urn:code:language:fi",
  "acceptorPersons" : [ {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person1",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  }, {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person2",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  } ],
  "organisations" : [ {
    "organisationId" : "test-organisation1",
    "educationalInstitutionUrn" : null,
    "roleUrn" : "urn:code:organisation-role:responsible-organisation",
    "share" : 1.0
  } ],
  "state" : "ATTAINED",
  "misregistration" : false,
  "misregistrationRationale" : null,
  "primary" : true,
  "credits" : 5.0,
  "studyWeeks" : null,
  "gradeScaleId" : "otm-gs1",
  "gradeId" : 0,
  "gradeAverage" : null,
  "additionalInfo" : null,
  "administrativeNote" : null,
  "studyFieldUrn" : null,
  "workflowId" : null,
  "moduleContentApplicationId" : null,
  "creditTransferInfo" : null,
  "cooperationNetworkStatus" : null,
  "rdiCredits" : null,
  "collaborationInstitution" : null,
  "enrolmentRightId" : null,
  "courseUnitId" : "otm-course-unit-1",
  "assessmentItemId" : "otm-assessment-item-1",
  "courseUnitRealisationId" : "otm-course-unit-realisation-1",
  "attainmentDate" : "2024-04-17",
  "type" : "AssessmentItemAttainment",
  "studentApplicationId" : null
}, {
  "metadata" : null,
  "documentState" : "ACTIVE",
  "id" : "otm-eac4f066-34ad-4e6e-aba9-c9869074bb61",
  "personId" : "test-esa",
  "personFirstNames" : null,
  "personLastName" : null,
  "personStudentNumber" : null,
  "verifierPersonId" : "otm-person1",
  "studyRightId" : "otm-3430d9a5-f056-4054-a010-cb02b7124438",
  "registrationDate" : "2024-04-18",
  "expiryDate" : null,
  "attainmentLanguageUrn" : "urn:code:language:fi",
  "acceptorPersons" : [ {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person1",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  }, {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person2",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  } ],
  "organisations" : [ {
    "organisationId" : "test-organisation1",
    "educationalInstitutionUrn" : null,
    "roleUrn" : "urn:code:organisation-role:responsible-organisation",
    "share" : 1.0
  } ],
  "state" : "ATTAINED",
  "misregistration" : false,
  "misregistrationRationale" : null,
  "primary" : true,
  "credits" : 5.0,
  "studyWeeks" : null,
  "gradeScaleId" : "otm-gs1",
  "gradeId" : 0,
  "gradeAverage" : null,
  "additionalInfo" : null,
  "administrativeNote" : null,
  "studyFieldUrn" : null,
  "workflowId" : null,
  "moduleContentApplicationId" : null,
  "creditTransferInfo" : null,
  "cooperationNetworkStatus" : null,
  "rdiCredits" : null,
  "collaborationInstitution" : null,
  "enrolmentRightId" : null,
  "courseUnitId" : "otm-course-unit-1",
  "assessmentItemId" : "otm-assessment-item-1",
  "courseUnitRealisationId" : "otm-course-unit-realisation-1",
  "attainmentDate" : "2009-02-06",
  "type" : "AssessmentItemAttainment",
  "studentApplicationId" : null
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Import legacy attainments

POST /api/attainments/v1/import/legacy

Import with a lenient legacy validation. Referred attainments must precede the referring attainments. So, if you have a course unit attainment with some assessment item attainment ids, the latter must come first in the import data. Course unit attainments can only refer to assessment item attainments. Module attainments and degree programme attainments cannot refer to assessment item attainments.

Parameters

Body Parameter
Name Description Schema Example

createAttainment_request required

List ([createAttainment_request])

Responses

Table 16. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/attainments/v1/import/legacy HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 1795
Host: localhost:8080

[ {
  "metadata" : null,
  "documentState" : "ACTIVE",
  "id" : "otm-attainment-mikko-1",
  "personId" : "otm-mikko",
  "personFirstNames" : null,
  "personLastName" : null,
  "personStudentNumber" : null,
  "verifierPersonId" : "otm-person1",
  "studyRightId" : "otm-7a177449-80be-4f0f-a020-9aaf1754a985",
  "registrationDate" : "2024-04-18",
  "expiryDate" : null,
  "attainmentLanguageUrn" : "urn:code:language:fi",
  "acceptorPersons" : [ {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person1",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  }, {
    "text" : {
      "fi" : "lokalisoitu kuvaus"
    },
    "personId" : "otm-person2",
    "roleUrn" : "urn:code:attainment-acceptor-type:approved-by",
    "title" : null
  } ],
  "organisations" : [ {
    "organisationId" : "test-organisation1",
    "educationalInstitutionUrn" : null,
    "roleUrn" : "urn:code:organisation-role:responsible-organisation",
    "share" : 1.0
  } ],
  "state" : "ATTAINED",
  "misregistration" : false,
  "misregistrationRationale" : null,
  "primary" : true,
  "credits" : 5.0,
  "studyWeeks" : null,
  "gradeScaleId" : "otm-gs1",
  "gradeId" : 0,
  "gradeAverage" : null,
  "additionalInfo" : null,
  "administrativeNote" : null,
  "studyFieldUrn" : null,
  "workflowId" : null,
  "moduleContentApplicationId" : null,
  "creditTransferInfo" : null,
  "cooperationNetworkStatus" : null,
  "rdiCredits" : null,
  "collaborationInstitution" : null,
  "enrolmentRightId" : null,
  "courseUnitId" : "otm-course-unit-1",
  "assessmentItemId" : "otm-assessment-item-1",
  "courseUnitRealisationId" : "otm-course-unit-realisation-1",
  "attainmentDate" : "2024-04-17",
  "type" : "AssessmentItemAttainment",
  "studentApplicationId" : null
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Patch attainments

PATCH /api/attainments/v1/import

Patch import with strict validation

Parameters

Body Parameter
Name Description Schema Example

PatchEntity required

List (PatchEntity)

Responses

Table 17. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Patch legacy attainments

PATCH /api/attainments/v1/import/legacy

Patch import with lenient legacy validation

Parameters

Body Parameter
Name Description Schema Example

PatchEntity required

List (PatchEntity)

Responses

Table 18. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Stream attainments

GET /api/attainments/v1/stream

Entities can be exported as a stream in modification order, and the stream can be left open to listen for changes. Duplicates are possible if entities are modified several times.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return entities modified after (exclusive comparison) this modification ordinal Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return entities modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

follow optional

Return entities modified after (exclusive comparison) this modification ordinal Alternate parameter with sinceTime. This is the recommended option.

Boolean

true

Responses

Table 19. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[[object]]
Produces

  • /

Samples

Export disclosure authorizations

GET /api/disclosures/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return disclosure authorizations modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return disclosure authorizations modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of disclosure authorizations to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 20. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultDisclosureAuthorization[ExportResultDisclosureAuthorization]
Produces

  • application/json

Samples

Import disclosure authorization

POST /api/disclosures/v1/import

Parameters

Body Parameter
Name Description Schema Example

DisclosureAuthorization required

List (DisclosureAuthorization)

Responses

Table 21. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Import enrolment rights

POST /api/enrolment-rights/v1/import

Parameters

Body Parameter
Name Description Schema Example

EnrolmentRight required

List (EnrolmentRight)

Responses

Table 22. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Import legacy enrolment rights. If documentState == null or documentState == ACTIVE, only a subset of mandatory EnrolmentRight fields are required for validation. If documentState == DRAFT or DELETED, there are no changes in validation.

POST /api/enrolment-rights/v1/import/legacy

Parameters

Body Parameter
Name Description Schema Example

EnrolmentRight required

List (EnrolmentRight)

Responses

Table 23. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export graduations

GET /api/graduations/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return graduations modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return graduations modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of graduations to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 24. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultGraduation[ExportResultGraduation]
Produces

  • application/json

Samples

Get the active graduation by attainment id

GET /api/graduations/attainment-active/{attainmentId}

Parameters

Path Parameters

Name

Description

Schema

Example

attainmentId required

String

otm-123456

Responses

Table 25. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Graduation[Graduation]
Produces

  • application/json

Samples

Export grants

GET /api/grants/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point. With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive. With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return grants modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return grants modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of grants to return. May return less, either because there are not enough items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 26. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultGrant[ExportResultGrant]
Produces

  • application/json

Samples

Import grants

POST /api/grants/v1/import

Parameters

Body Parameter
Name Description Schema Example

Grant required

List (Grant)

Responses

Table 27. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export mobility periods

GET /api/mobility-periods/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return mobility periods modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return mobility periods modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of mobility periods to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 28. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultMobilityPeriod[ExportResultMobilityPeriod]
Produces

  • application/json

Samples

Import mobility periods

POST /api/mobility-periods/v1/import

Parameters

Body Parameter
Name Description Schema Example

MobilityPeriod required

List (MobilityPeriod)

Responses

Table 29. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Import OILI document

POST /api/oili/documents/v1/import

Parameters

Body Parameter
Name Description Schema Example

OiliDocument required

OiliDocument (OiliDocument)
Header Parameters
Name Description Schema Example

X-OILI-Hash optional

String

xOILIHash_example

Responses

Table 30. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

String[[string]]
Produces

  • text/plain

  • application/json

Samples

Disable login

PUT /api/disable-login

Causes all IDP-based user authentication to fail. In addition to new logins will also cause the periodical reauthentication to fail, so already logged in will be thrown out once the preauth TTL is over. Throws error if login is already disabled. NOTE! The propagation of the disable to all distributed nodes will take up to several minutes.

Parameters

Responses

Table 31. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Enable login

PUT /api/enable-login

Enables previously disabled login. Throws error if login is already enabled. NOTE! The propagation of the enable to all distributed nodes will take up to several minutes.

Parameters

Responses

Table 32. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export passports

GET /api/passports/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return passports modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return passports modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of passports to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 33. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPassport[ExportResultPassport]
Produces

  • application/json

Samples

Import passports

POST /api/passports/v1/import

Parameters

Body Parameter
Name Description Schema Example

Passport required

List (Passport)

Responses

Table 34. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Delete person group memberships

POST /api/person-groups/v1/{personGroupId}/memberships/delete

Parameters

Path Parameters

Name

Description

Schema

Example

personGroupId required

Id of the person group the person group person membership belongs to

String

otm-123456
Body Parameter
Name Description Schema Example

string required

List ([string])

Responses

Table 35. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export person groups

GET /api/person-groups/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return person groups modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return person groups modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of person groups to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 36. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPersonGroup[ExportResultPersonGroup]
Produces

  • application/json

Samples

GET /api/person-groups/v1/export?since=53764&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 694

{
  "greatestOrdinal" : 53765,
  "hasMore" : false,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "arska",
      "createdOn" : "2024-04-18T12:41:50.491487",
      "lastModifiedBy" : "arska",
      "lastModifiedOn" : "2024-04-18T12:41:50.491511",
      "modificationOrdinal" : 53765
    },
    "documentState" : "ACTIVE",
    "id" : "otm-3e601e2c-5a98-4e3b-8316-22b9da3e5261",
    "name" : {
      "fi" : "New Person Group"
    },
    "description" : null,
    "updateType" : "MANUAL",
    "membershipUpdateTime" : null,
    "membershipCheckTime" : null,
    "responsibilityInfos" : [ ],
    "personQueries" : null,
    "type" : "TUTORING_STUDENT_GROUP"
  } ]
}

Get person group memberships for person group

GET /api/person-groups/v1/{personGroupId}/memberships

Parameters

Path Parameters

Name

Description

Schema

Example

personGroupId required

String

otm-123456

Responses

Table 37. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[PersonGroupMembership]
Produces

  • /

Samples

Import person group memberships

POST /api/person-groups-memberships/v1/import

Parameters

Body Parameter
Name Description Schema Example

PersonGroupMembership required

List (PersonGroupMembership)

Responses

Table 38. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/person-groups-memberships/v1/import HTTP/1.1
Content-Type: application/json
Content-Length: 391
Host: localhost:8080

[ {
  "id" : "otm-742f32c8-08cb-4514-a844-ec9f5c0a743f",
  "personGroupId" : "otm-0c109c57-4a56-460b-ba9f-1af4eccd79b9",
  "personGroupName" : null,
  "personId" : "otm-ozzi-user",
  "personFirstNames" : null,
  "personLastName" : null,
  "personStudentNumber" : null,
  "validityPeriod" : {
    "startDate" : "2024-04-18",
    "endDate" : "2024-04-19"
  },
  "personPrimaryEmail" : null
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Import person groups

POST /api/person-groups/v1/import

Parameters

Body Parameter
Name Description Schema Example

importPersonGroups_request_inner required

List ([importPersonGroups_request_inner])

Responses

Table 39. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/person-groups/v1/import HTTP/1.1
Content-Type: application/json
Content-Length: 1195
Host: localhost:8080

[ {
  "metadata" : {
    "revision" : 1,
    "createdBy" : "arska",
    "createdOn" : "2024-04-18T12:41:49.512886",
    "lastModifiedBy" : "arska",
    "lastModifiedOn" : "2024-04-18T12:41:49.512904",
    "modificationOrdinal" : null
  },
  "documentState" : "ACTIVE",
  "id" : "otm-37904fad-e718-428a-a90a-17130dfa152f",
  "name" : {
    "en" : "Test group, student tutoring group",
    "fi" : "Testiryhmä, ohjausryhmä"
  },
  "description" : null,
  "updateType" : "MANUAL",
  "membershipUpdateTime" : null,
  "membershipCheckTime" : null,
  "responsibilityInfos" : [ {
    "text" : null,
    "personId" : "test-eki",
    "roleUrn" : "urn:code:group-responsibility-info-type:responsible-tutor",
    "validityPeriod" : {
      "endDate" : "2024-04-17"
    }
  }, {
    "text" : null,
    "personId" : "test-teemu",
    "roleUrn" : "urn:code:group-responsibility-info-type:responsible-tutor",
    "validityPeriod" : {
      "startDate" : "2024-04-19"
    }
  }, {
    "text" : null,
    "personId" : "otm-urho-user",
    "roleUrn" : "urn:code:group-responsibility-info-type:responsible-tutor",
    "validityPeriod" : { }
  } ],
  "personQueries" : null,
  "type" : "TUTORING_STUDENT_GROUP"
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Create or update person group memberships.

POST /api/person-groups/v1/{personGroupId}/memberships

Parameters

Path Parameters

Name

Description

Schema

Example

personGroupId required

Id of the person group the person group person membership belongs to

String

otm-123456
Body Parameter
Name Description Schema Example

PersonGroupMembership required

List (PersonGroupMembership)

Responses

Table 40. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[PersonGroupMembership]
Produces

  • /

Samples

Create person

POST /api/persons

Parameters

Body Parameter
Name Description Schema Example

PrivatePerson required

PrivatePerson (PrivatePerson)

Responses

Table 41. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

PrivatePerson[PrivatePerson]
Produces

  • /

Samples

Export active staff members

GET /api/persons/v1/export-active-staff

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return active staff members modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return active staff members modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of active staff members to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 42. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPrivatePerson[ExportResultPrivatePerson]
Produces

  • application/json

Samples

Export active students

GET /api/persons/v1/export-active-students

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return active students modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return active students modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of active students to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 43. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPrivatePerson[ExportResultPrivatePerson]
Produces

  • application/json

Samples

Export person data change history

GET /api/persons/history/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return person data changes modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return person data changes modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of person data changes to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 44. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPersonDataChange[ExportResultPersonDataChange]
Produces

  • application/json

Samples

GET /api/persons/history/v1/export?sinceTime=2024-04-18T12%3A41%3A58.962021989&limit=5 HTTP/1.1
Accept: application/json
Authorization: Basic aHkuZTp0ZXN0MTIz
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 694

{
  "greatestOrdinal" : 54846,
  "hasMore" : false,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "arska",
      "createdOn" : "2024-04-18T12:41:58.96216",
      "lastModifiedBy" : "arska",
      "lastModifiedOn" : "2024-04-18T12:41:58.962174",
      "modificationOrdinal" : 54846
    },
    "documentState" : "ACTIVE",
    "id" : "otm-ee07724d-ea5a-4ca2-9d6c-c0409da2299a",
    "personId" : "otm-person1",
    "modifiedBy" : null,
    "modifiedByName" : null,
    "modified" : "2024-04-18T12:41:58.962021989",
    "validUntil" : null,
    "oldPersonalIdentityCode" : null,
    "oldFirstNames" : null,
    "oldLastName" : null,
    "correction" : false
  } ]
}

Export persons

GET /api/persons/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return private persons modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return private persons modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of private persons to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 45. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultPrivatePerson[ExportResultPrivatePerson]
Produces

  • application/json

Samples

GET /api/persons/v1/export?since=54976&limit=5 HTTP/1.1
Accept: application/json
Authorization: Basic aHkuZTp0ZXN0MTIz
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1312

{
  "greatestOrdinal" : 54977,
  "hasMore" : false,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "arska",
      "createdOn" : "2024-04-18T12:41:59.49517",
      "lastModifiedBy" : "arska",
      "lastModifiedOn" : "2024-04-18T12:41:59.495187",
      "modificationOrdinal" : 54977
    },
    "documentState" : "ACTIVE",
    "id" : "otm-person1",
    "studentNumber" : "1",
    "personalIdentityCode" : null,
    "finnAuthId" : null,
    "eidasId" : null,
    "dateOfBirth" : null,
    "userName" : null,
    "eduPersonPrincipalName" : null,
    "employeeNumber" : null,
    "phoneNumber" : null,
    "primaryAddress" : null,
    "secondaryAddress" : null,
    "genderUrn" : "urn:code:gender:not-known",
    "citizenshipUrns" : null,
    "motherTongueUrn" : null,
    "preferredLanguageUrn" : null,
    "schoolEducationLanguageUrns" : null,
    "municipalityUrn" : null,
    "oppijanumero" : null,
    "oids" : [ ],
    "dead" : false,
    "classifiedPersonInfo" : null,
    "personalDataSafetyNonDisclosure" : false,
    "studentStatus" : "NONE",
    "employeeStatus" : "NONE",
    "identityConfirmed" : true,
    "oppijaID" : null,
    "firstNames" : "Pekka",
    "callName" : "Peksi",
    "lastName" : "Henkilö",
    "primaryEmail" : null,
    "secondaryEmail" : null
  } ]
}

Get person by id

GET /api/persons/v1/{personId}

Get all person details by personId, including personal identity code.

Parameters

Path Parameters

Name

Description

Schema

Example

personId required

String

otm-123456

Responses

Table 46. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

PrivatePerson[PrivatePerson]
Produces

  • application/json

Samples

Get full person sensitive information change history including personal identity codes.

GET /api/persons/v1/{personId}/history/full

Parameters

Path Parameters

Name

Description

Schema

Example

personId required

String

personId_example

Responses

Table 47. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[PersonDataChange]
Produces

  • application/json

Samples

Get full person information excluding personal identity code of multiple persons.

GET /api/persons

Parameters

Query Parameters
Name Description Schema Example

id required

Set ([String])

Responses

Table 48. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[PrivatePerson]
Produces

  • application/json

Samples

Import persons

POST /api/persons/v1/import

Parameters

Body Parameter
Name Description Schema Example

PrivatePerson required

List (PrivatePerson)

Responses

Table 49. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/persons/v1/import HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Basic aHkuaTp0ZXN0MTIz
Content-Length: 9780
Host: localhost:8080

[ {
  "metadata" : null,
  "id" : "otm-dc6498b5-206c-471a-b7f9-56473b515766",
  "studentNumber" : "otm-dc6498b5-206c-471a-b7f9-56473b515766",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : "2000-01-01",
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "John",
  "callName" : "Jonny",
  "lastName" : "Doe",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-6a5706df-beea-4eb5-a2e1-0cf6b1744123",
  "studentNumber" : "otm-6a5706df-beea-4eb5-a2e1-0cf6b1744123",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Jane",
  "callName" : "Jenny",
  "lastName" : "Doe",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-986fe2bd-c824-4db5-8320-17176eae59ca",
  "studentNumber" : "otm-986fe2bd-c824-4db5-8320-17176eae59ca",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Mike",
  "callName" : null,
  "lastName" : "Smith",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-6cc88312-4d72-493d-ae07-6f3693fefce8",
  "studentNumber" : "otm-6cc88312-4d72-493d-ae07-6f3693fefce8",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "June",
  "callName" : null,
  "lastName" : "Johnson",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-e0a31aad-e78e-4e68-8882-8ddea9967ece",
  "studentNumber" : "otm-e0a31aad-e78e-4e68-8882-8ddea9967ece",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "John",
  "callName" : null,
  "lastName" : "Smith",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-b3b08ca3-68f7-4cac-88f8-dcc0dfc2fede",
  "studentNumber" : "otm-b3b08ca3-68f7-4cac-88f8-dcc0dfc2fede",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "James",
  "callName" : "John",
  "lastName" : "Miller",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-81102b08-8057-437e-911c-28ef0e8db9d3",
  "studentNumber" : "otm-81102b08-8057-437e-911c-28ef0e8db9d3",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Jane",
  "callName" : null,
  "lastName" : "Davis",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-a58fbe26-c557-4449-ab5f-80a884d44d68",
  "studentNumber" : "otm-a58fbe26-c557-4449-ab5f-80a884d44d68",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Don",
  "callName" : null,
  "lastName" : "Brown",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-3eb765d0-1a04-48c7-b243-56ce87fa2d11",
  "studentNumber" : "otm-3eb765d0-1a04-48c7-b243-56ce87fa2d11",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Rick",
  "callName" : null,
  "lastName" : "Wilson",
  "primaryEmail" : null,
  "secondaryEmail" : null
}, {
  "metadata" : null,
  "id" : "otm-e9d15212-11ca-4c2f-ac17-8b05811bb359",
  "studentNumber" : "otm-e9d15212-11ca-4c2f-ac17-8b05811bb359",
  "personalIdentityCode" : null,
  "finnAuthId" : null,
  "eidasId" : null,
  "dateOfBirth" : null,
  "userName" : null,
  "eduPersonPrincipalName" : null,
  "employeeNumber" : null,
  "phoneNumber" : null,
  "primaryAddress" : null,
  "secondaryAddress" : null,
  "genderUrn" : "urn:code:gender:not-known",
  "citizenshipUrns" : null,
  "motherTongueUrn" : null,
  "preferredLanguageUrn" : null,
  "schoolEducationLanguageUrns" : null,
  "municipalityUrn" : null,
  "oppijanumero" : null,
  "oids" : [ ],
  "dead" : false,
  "classifiedPersonInfo" : null,
  "personalDataSafetyNonDisclosure" : false,
  "studentStatus" : "ACTIVE",
  "employeeStatus" : "NONE",
  "identityConfirmed" : true,
  "oppijaID" : null,
  "firstNames" : "Abe",
  "callName" : null,
  "lastName" : "Williams",
  "primaryEmail" : null,
  "secondaryEmail" : null
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Import persons sensitive data change

POST /api/persons/history/v1/import

Parameters

Body Parameter
Name Description Schema Example

PersonDataChange required

List (PersonDataChange)

Responses

Table 50. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Patch people

PATCH /api/persons/v1/import

Parameters

Body Parameter
Name Description Schema Example

PrivatePersonPatchEntity required

List (PrivatePersonPatchEntity)

Responses

Table 51. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[PrivatePerson]
Produces

  • application/json

Samples

Stream persons

GET /api/persons/v1/stream

Entities can be exported as a stream in modification order, and the stream can be left open to listen for changes. Duplicates are possible if entities are modified several times.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return entities modified after (exclusive comparison) this modification ordinal Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return entities modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

follow optional

Return entities modified after (exclusive comparison) this modification ordinal Alternate parameter with sinceTime. This is the recommended option.

Boolean

true

Responses

Table 52. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[[object]]
Produces

  • /

Samples

Export student payments

GET /api/student-payments/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point. With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive. With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return student payments modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return student payments modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of student payments to return. May return less, either because there are not enough items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 53. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultStudentPayment[ExportResultStudentPayment]
Produces

  • application/json

Samples

Import student payments

POST /api/student-payments/v1/import

Parameters

Body Parameter
Name Description Schema Example

importStudentPayments_request_inner required

List ([importStudentPayments_request_inner])

Responses

Table 54. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Delete the study right active snapshot by study right id. (Sets state to DELETED)

DELETE /api/study-rights/v1/{studyRightId}

Parameters

Path Parameters

Name

Description

Schema

Example

studyRightId required

String

otm-123456

Responses

Table 55. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Delete the study right oldest snapshot which does not have 'snapshotDateTime' by study right id. (Sets state to DELETED)

DELETE /api/study-rights/v1/{studyRightId}/-inf

Parameters

Path Parameters

Name

Description

Schema

Example

studyRightId required

String

otm-123456

Responses

Table 56. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Delete the study right snapshot by study right id and snapshotDateTime. (Sets state to DELETED)

DELETE /api/study-rights/v1/{studyRightId}/{snapshotDateTime}

Parameters

Path Parameters

Name

Description

Schema

Example

studyRightId required

String

otm-123456

snapshotDateTime required

Date (date-time)

2013-10-20T19:20:30+01:00

Responses

Table 57. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Delete all the study right snapshots by study right id. (Sets state to DELETED)

DELETE /api/study-rights/v1/{studyRightId}/snapshots

Parameters

Path Parameters

Name

Description

Schema

Example

studyRightId required

String

otm-123456

Responses

Table 58. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export ids of study rights that have changed since ordinal

GET /api/study-rights/current-ids-only/v1/export

Entities' ids can be exported in modification order based on 'since' parameter: an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. The since parameters is exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since required

Return List of ids of studyrights modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

limit required

Maximum number of study rights to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 59. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportIdResultOtmIdStudyRight[ExportIdResultOtmIdStudyRight]
Produces

  • application/json

Samples

GET /api/study-rights/current-ids-only/v1/export?since=57905&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 66

{
  "greatestOrdinal" : null,
  "hasMore" : false,
  "ids" : [ ]
}

Export studentIds of study rights that have changed since ordinal

GET /api/study-rights/current-student-ids-only/v1/export

Entities' ids can be exported in modification order based on 'since' parameter: an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. The since parameters is exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since required

Return List of ids of studyrights modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

limit required

Maximum number of study rights to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 60. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportAssigneeIdResultStudyRight[ExportAssigneeIdResultStudyRight]
Produces

  • application/json

Samples

GET /api/study-rights/current-student-ids-only/v1/export?since=58147&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 72

{
  "greatestOrdinal" : null,
  "hasMore" : false,
  "personIds" : [ ]
}

Export current study rights

GET /api/study-rights/current/v1/export

Entities can be exported in modification order based on 'since' parameter: an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. The since parameters is exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since required

Return study rights modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

limit required

Maximum number of study rights to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 61. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultStudyRight[ExportResultStudyRight]
Produces

  • application/json

Samples

GET /api/study-rights/current/v1/export?since=57055&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 71

{
  "greatestOrdinal" : null,
  "hasMore" : false,
  "entities" : [ ]
}

Export study rights

GET /api/study-rights/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return study rights modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return study rightsmodified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of study rights to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 62. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultStudyRight[ExportResultStudyRight]
Produces

  • application/json

Samples

GET /api/study-rights/v1/export?since=57784&limit=5 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2550

{
  "greatestOrdinal" : 57786,
  "hasMore" : false,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "internal.i",
      "createdOn" : "2024-04-18T12:42:07.345214",
      "lastModifiedBy" : "internal.i",
      "lastModifiedOn" : "2024-04-18T12:42:07.345236",
      "modificationOrdinal" : 57786
    },
    "documentState" : "ACTIVE",
    "id" : "otm-0d681396-9b5f-4990-86fe-59a3f4ef5b60",
    "snapshotDateTime" : "2023-09-18T12:42:07.327661",
    "studentId" : "test-eki",
    "educationId" : "test-edu-1",
    "organisationId" : "the-spectre",
    "learningOpportunityId" : "test-lo-1",
    "admissionTargetId" : null,
    "admissionIdentifier" : null,
    "decreeOnUniversityDegreesUrn" : "urn:code:decree-on-university-degrees:decree-2015",
    "studyRightExpirationRulesUrn" : "urn:code:study-right-expiration-rules:2015-ma",
    "degreeRegulations" : null,
    "valid" : {
      "startDate" : "2022-01-01",
      "endDate" : "2026-01-01"
    },
    "grantDate" : "2016-01-01",
    "studyStartDate" : "2022-01-01",
    "transferOutDate" : null,
    "transferOutUniversityUrn" : null,
    "homeOrganisationUrn" : null,
    "termRegistrations" : [ ],
    "studyRightExtensions" : null,
    "studyRightCancellation" : null,
    "studyRightGraduation" : null,
    "acceptedSelectionPath" : { },
    "requestedSelectionPath" : { },
    "studyRightTransfer" : null,
    "phase1MinorSelections" : null,
    "phase2MinorSelections" : null,
    "state" : null,
    "statePeriods" : [ ],
    "personalizedSelectionPath" : null,
    "courseUnitSelections" : null,
    "moduleSelections" : null,
    "studyFieldUrn" : "urn:code:study-field:2002-0",
    "phase1EducationClassificationUrn" : "urn:code:education-classification:koulutus_623112",
    "phase2EducationClassificationUrn" : "urn:code:education-classification:koulutus_751901",
    "phase1EducationClassificationLocked" : false,
    "phase2EducationClassificationLocked" : false,
    "fundingSourceUrn" : null,
    "phase1QualificationUrns" : [ ],
    "phase2QualificationUrns" : [ ],
    "phase1EducationLocationUrn" : "urn:code:municipality:091",
    "phase2EducationLocationUrn" : "urn:code:municipality:091",
    "phase1InternationalContractualDegree" : null,
    "phase2InternationalContractualDegree" : null,
    "admissionTypeUrn" : null,
    "codeUrns" : [ ],
    "additionalInformation" : null,
    "basedOnEnrolmentRights" : false,
    "cooperationNetworkRights" : null,
    "cooperationNetworkStatus" : null,
    "schoolEducationLanguageUrn" : null
  } ]
}

Get the study rights of persons. Only for internal use.

POST /api/study-rights/v1/for-person

Parameters

Body Parameter
Name Description Schema Example

string required

List ([string])

Responses

Table 63. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[StudyRight]
Produces

  • application/json

Samples

Get study rights for person

GET /api/study-rights/v1/for-person

Get all ACTIVE study rights by person id

Parameters

Query Parameters
Name Description Schema Example

personId required

String

otm-123456

Responses

Table 64. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[StudyRight]
Produces

  • application/json

Samples

Import study rights.

POST /api/study-rights/v1/import

Use override=true to discard all existing stored snapshots of study rights. In other words you’ll overwrite snapshots of study right with the imported snapshot set.

Parameters

Body Parameter
Name Description Schema Example

StudyRight required

List (StudyRight)
Query Parameters
Name Description Schema Example

override optional

Boolean

true

Responses

Table 65. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

POST /api/study-rights/v1/import HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 2361
Authorization: Basic aW50ZXJuYWwuaTp0ZXN0MTIz
Host: localhost:8080

[ {
  "metadata" : null,
  "documentState" : "ACTIVE",
  "id" : "otm-eb1e0126-9427-4295-b9ae-5dc2e0972358",
  "snapshotDateTime" : null,
  "studentId" : "test-eki",
  "educationId" : "test-edu-1",
  "organisationId" : "the-spectre",
  "learningOpportunityId" : "test-lo-1",
  "admissionTargetId" : null,
  "admissionIdentifier" : null,
  "decreeOnUniversityDegreesUrn" : "urn:code:decree-on-university-degrees:decree-2015",
  "studyRightExpirationRulesUrn" : "urn:code:study-right-expiration-rules:2015-ma",
  "degreeRegulations" : null,
  "valid" : {
    "startDate" : "2022-01-01",
    "endDate" : "2026-01-01"
  },
  "grantDate" : "2016-01-01",
  "studyStartDate" : "2022-01-01",
  "transferOutDate" : null,
  "transferOutUniversityUrn" : null,
  "homeOrganisationUrn" : null,
  "termRegistrations" : [ ],
  "studyRightExtensions" : null,
  "studyRightCancellation" : null,
  "studyRightGraduation" : null,
  "acceptedSelectionPath" : { },
  "requestedSelectionPath" : { },
  "studyRightTransfer" : null,
  "phase1MinorSelections" : null,
  "phase2MinorSelections" : null,
  "state" : "ACTIVE",
  "statePeriods" : [ {
    "state" : "NOT_STARTED",
    "startDate" : "2021-12-01",
    "endDate" : "2022-01-01"
  }, {
    "state" : "ACTIVE",
    "startDate" : "2022-01-01",
    "endDate" : "2026-01-01"
  }, {
    "state" : "PASSIVE",
    "startDate" : "2026-01-01"
  } ],
  "personalizedSelectionPath" : null,
  "courseUnitSelections" : null,
  "moduleSelections" : null,
  "studyFieldUrn" : "urn:code:study-field:2002-0",
  "phase1EducationClassificationUrn" : "urn:code:education-classification:koulutus_623112",
  "phase2EducationClassificationUrn" : "urn:code:education-classification:koulutus_751901",
  "phase1EducationClassificationLocked" : false,
  "phase2EducationClassificationLocked" : false,
  "fundingSourceUrn" : null,
  "phase1QualificationUrns" : [ ],
  "phase2QualificationUrns" : [ ],
  "phase1EducationLocationUrn" : "urn:code:municipality:091",
  "phase2EducationLocationUrn" : "urn:code:municipality:091",
  "phase1InternationalContractualDegree" : null,
  "phase2InternationalContractualDegree" : null,
  "admissionTypeUrn" : null,
  "codeUrns" : [ ],
  "additionalInformation" : null,
  "basedOnEnrolmentRights" : false,
  "cooperationNetworkRights" : null,
  "cooperationNetworkStatus" : null,
  "schoolEducationLanguageUrn" : null
} ]
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Patch study rights

PATCH /api/study-rights/v1/import

Parameters

Body Parameter
Name Description Schema Example

TemporalPatchEntity required

List (TemporalPatchEntity)

Responses

Table 66. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[StudyRight]
Produces

  • application/json

Samples

Calculate StudyRight primality history for all students

POST /api/study-right-primalities/calculate-history-for-all-students

Parameters

Query Parameters
Name Description Schema Example

saveChanges required

By default, changes are not saved to database, but a dryRun is performed instead. By specifying saveChanges=true, the calculation result is saved to database.

Boolean

true

Responses

Table 67. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

StudyRightPrimalityUpdateResult[StudyRightPrimalityUpdateResult]
Produces

  • application/json

Samples

Calculate StudyRight primality history for students, identified by listed ids

POST /api/study-right-primalities/calculate-history-for-students

Parameters

Body Parameter
Name Description Schema Example

string required

List ([string])
Query Parameters
Name Description Schema Example

saveChanges required

By default, changes are not saved to database, but a dryRun is performed instead. By specifying saveChanges=true, the calculation result is saved to database.

Boolean

true

Responses

Table 68. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[[string]]
Produces

  • application/json

Samples

Export study right primality data

GET /api/study-right-primalities/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point. With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive. With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return study right primalities modified after (exclusive comparison) this modification ordinal (increasing value within Kori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return study right primalities modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of study right primalities to return. May return less, either because there are not enough items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 69. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultStudyRightPrimality[ExportResultStudyRightPrimality]
Produces

  • application/json

Samples

Import study right primality data. Deletes all primality data related to students for which new data is imported.

POST /api/study-right-primalities/v1/import

Parameters

Body Parameter
Name Description Schema Example

StudyRightPrimality required

List (StudyRightPrimality)

Responses

Table 70. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export term registrations

GET /api/term-registrations/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return term registrations modified after (exclusive comparison) this modification ordinal (increasing value within Kori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return term registrations modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of term registrations to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 71. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultStudyRightTermRegistrations[ExportResultStudyRightTermRegistrations]
Produces

  • application/json

Samples

Import individual term registrations for study rights. No other study right data is updated

POST /api/study-rights/term-registrations/v1/import

Parameters

Body Parameter
Name Description Schema Example

TermRegistrationForStudyRight required

List (TermRegistrationForStudyRight)

Responses

Table 72. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Import term registrations

POST /api/term-registrations/v1/import

Parameters

Body Parameter
Name Description Schema Example

StudyRightTermRegistrations required

List (StudyRightTermRegistrations)

Responses

Table 73. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Patch individual term registrations for study rights. No other study right data is updated

PATCH /api/study-rights/term-registrations/v1/import

Parameters

Body Parameter
Name Description Schema Example

TermRegistrationForStudyRightPatchEntity required

List (TermRegistrationForStudyRightPatchEntity)

Responses

Table 74. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

List[TermRegistrationForStudyRight]
Produces

  • /

Samples

Patch term registrations

PATCH /api/term-registrations/v1/import

Parameters

Body Parameter
Name Description Schema Example

StudyRightTermRegistrationsPatchEntity required

List (StudyRightTermRegistrationsPatchEntity)

Responses

Table 75. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export term registration periods

GET /api/term-registration-periods/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point. With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive. With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

sinceOrdinal optional

Long (int64)

789

sinceTime optional

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

The maximum amount of results to return.

Integer (int32)

56

Responses

Table 76. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultTermRegistrationPeriod[ExportResultTermRegistrationPeriod]
Produces

  • application/json

Samples

Import term registration periods

POST /api/term-registration-periods/v1/import

Parameters

Body Parameter
Name Description Schema Example

TermRegistrationPeriod required

List (TermRegistrationPeriod)

Responses

Table 77. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export Theses

GET /api/thesis/v1/export

Parameters

Query Parameters
Name Description Schema Example

since optional

Exclusive

Long (int64)

789

sinceTime optional

Exclusive

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Integer (int32)

56

Responses

Table 78. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultThesis[ExportResultThesis]
Produces

  • application/json

Samples

Import Theses

POST /api/thesis/v1/import

Parameters

Body Parameter
Name Description Schema Example

Thesis required

List (Thesis)

Responses

Table 79. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export tuition fee obligation periods

GET /api/tuition-fee-obligation-periods/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point. With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be consecutive. With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return enrolments modified after (exclusive comparison) this modification ordinal (increasing value within ILMO). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return enrolments modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of enrolments to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 80. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultTuitionFeeObligationPeriod[ExportResultTuitionFeeObligationPeriod]
Produces

  • application/json

Samples

Import tuition fee obligation periods

POST /api/tuition-fee-obligation-periods/v1/import

Parameters

Body Parameter
Name Description Schema Example

TuitionFeeObligationPeriod required

List (TuitionFeeObligationPeriod)

Responses

Table 81. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export user settings.

GET /api/user-settings/v1/export

Parameters

Query Parameters
Name Description Schema Example

since optional

Return user settings modified after (exclusive comparison) this modification ordinal. Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return user settings modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of user settings entries to return. May return less, either because there are not enough entries, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 82. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultUserSettings[ExportResultUserSettings]
Produces

  • application/json

Samples

Import user settings.

POST /api/user-settings/v1/import

Parameters

Body Parameter
Name Description Schema Example

UserSettings required

List (UserSettings)

Responses

Table 83. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Export workflows

GET /api/workflows/v1/export

Entities can be exported in modification order based on one of two separate ways of specifying the starting point.With the 'since' parameter (recommended): an integer key (modification ordinal), which is different for every modification of the entity table. The ordinals are guaranteed to increase for each modification, but not guaranteed to be concecutive.With the 'sinceTime' parameter: an ISO-8601 timestamp. SinceTime is only supported for the case when the modification ordinal is not known by the exporter. In actual practice, if efficient export of all data is desired, the greatest modification ordinal from the previous export must be remembered and used as the since parameter for the next export. Both the since and sinceTime parameters are exclusive: if in one export you get the modification ordinals 3, 4 and 5, the next query should be export?since=5 and then you get the ordinals 6, 7, 8, etc.

Parameters

Query Parameters
Name Description Schema Example

since optional

Return workflows modified after (exclusive comparison) this modification ordinal (increasing value within Ori). Alternate parameter with sinceTime. This is the recommended option.

Long (int64)

789

sinceTime optional

Return workflows modified after (exclusive comparison) this ISO-8601 time. Alternate parameter with since. This is the not recommended but sometimes necessary option.

Date (date-time)

2013-10-20T19:20:30+01:00

limit required

Maximum number of workflows to return. May return less, either because there are not enough change items, or because of internal limits. If limit is higher than 10 000, returns only 10 000 items.

Integer (int32)

56

Responses

Table 84. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

ExportResultWorkflow[ExportResultWorkflow]
Produces

  • application/json

Samples

GET /api/workflows/v1/export?since=0&limit=2 HTTP/1.1
Accept: application/json
Host: localhost:8080
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4460

{
  "greatestOrdinal" : 59631,
  "hasMore" : true,
  "entities" : [ {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "spectre.i",
      "createdOn" : "2024-04-18T12:42:14.499282",
      "lastModifiedBy" : "spectre.i",
      "lastModifiedOn" : "2024-04-18T12:42:14.499282",
      "modificationOrdinal" : 59630
    },
    "documentState" : "ACTIVE",
    "id" : "otm-601b6aa8-1121-4437-a972-12cb94f95d51",
    "state" : "REQUESTED",
    "code" : "A002",
    "lastHandlerPersonId" : null,
    "lastHandledTime" : null,
    "assignedHandlerId" : null,
    "creationTime" : "2024-04-18T12:42:13.499372844",
    "organisations" : [ {
      "organisationId" : "otm-9e336987-2895-460b-a9d2-a2797dcdcf24",
      "educationalInstitutionUrn" : null,
      "roleUrn" : "urn:code:organisation-role:responsible-organisation",
      "share" : 1
    } ],
    "application" : null,
    "applicationHistory" : [ ],
    "decision" : null,
    "decisionHistory" : [ ],
    "createdByPersonId" : "test-teemu",
    "studentId" : "test-teemu",
    "initiatorType" : "STUDENT",
    "cancellingDisabled" : false,
    "personFirstNames" : null,
    "personLastName" : null,
    "personStudentNumber" : null,
    "mustPrintDecision" : false,
    "cancellerId" : null,
    "cancelReason" : null,
    "cancelTime" : null,
    "cancelledByType" : null,
    "studyRightId" : "otm-d28fef70-344a-453c-b149-38353b20a754",
    "planId" : "otm-fb6d783c-496d-45b7-a9b6-c0487b25e78e",
    "formalRecommendation" : null,
    "contentRecommendation" : null,
    "priorLearnings" : [ {
      "localId" : "loc-id",
      "type" : "STUDIES",
      "name" : "Amazing space exploration",
      "organisation" : "University of Uranus",
      "description" : "Some nice lectures abt space",
      "attainmentLanguage" : null,
      "code" : "1002",
      "attainmentDate" : "2018-01-01",
      "grade" : "A ok",
      "gradeScale" : "ABC",
      "credits" : "3 op"
    } ],
    "courseUnitId" : "otm-6a5773c0-6e08-4edc-89b3-0f13b5430e38",
    "courseUnitGroupId" : "otm-f5497048-ce6c-4e7b-9083-f177dce85e02",
    "type" : "PriorLearningSubstitutionWorkflow"
  }, {
    "metadata" : {
      "revision" : 1,
      "createdBy" : "spectre.i",
      "createdOn" : "2024-04-18T12:42:14.499282",
      "lastModifiedBy" : "spectre.i",
      "lastModifiedOn" : "2024-04-18T12:42:14.499282",
      "modificationOrdinal" : 59631
    },
    "documentState" : "ACTIVE",
    "id" : "otm-4e251beb-e594-483d-b03e-7099fa17ed05",
    "state" : "REQUESTED",
    "code" : "1001",
    "lastHandlerPersonId" : null,
    "lastHandledTime" : null,
    "assignedHandlerId" : null,
    "creationTime" : "2024-04-18T12:42:13.499389375",
    "organisations" : [ {
      "organisationId" : "otm-9e336987-2895-460b-a9d2-a2797dcdcf24",
      "educationalInstitutionUrn" : null,
      "roleUrn" : "urn:code:organisation-role:responsible-organisation",
      "share" : 1
    } ],
    "application" : null,
    "applicationHistory" : [ ],
    "decision" : null,
    "decisionHistory" : [ ],
    "createdByPersonId" : "test-eki",
    "studentId" : "test-eki",
    "initiatorType" : "STUDENT",
    "cancellingDisabled" : false,
    "personFirstNames" : null,
    "personLastName" : null,
    "personStudentNumber" : null,
    "mustPrintDecision" : false,
    "cancellerId" : null,
    "cancelReason" : null,
    "cancelTime" : null,
    "cancelledByType" : null,
    "studyRightId" : "otm-4bb9d5e7-4cb3-4790-9720-0d89ce9a09dd",
    "planId" : "otm-fb6d783c-496d-45b7-a9b6-c0487b25e78e",
    "formalRecommendation" : null,
    "contentRecommendation" : null,
    "priorLearnings" : [ {
      "localId" : "loc-id",
      "type" : "STUDIES",
      "name" : "Amazing space exploration",
      "organisation" : "University of Uranus",
      "description" : "Some nice lectures abt space",
      "attainmentLanguage" : null,
      "code" : "1002",
      "attainmentDate" : "2018-01-01",
      "grade" : "A ok",
      "gradeScale" : "ABC",
      "credits" : "3 op"
    } ],
    "name" : "Sisälmyshakemus",
    "plannedParentModuleId" : "otm-6a369b68-61e5-47f1-b173-99b658cf60e7",
    "degreeProgrammeId" : "otm-5f173d38-df6d-4005-bfdf-feb8f0ebe4e5",
    "degreeProgrammeGroupId" : "otm-a9032acf-129d-4d67-b19a-c4933468d37d",
    "customStudyDraft" : null,
    "moduleId" : "otm-5f173d38-df6d-4005-bfdf-feb8f0ebe4e5",
    "moduleGroupId" : "otm-a9032acf-129d-4d67-b19a-c4933468d37d",
    "type" : "PriorLearningInclusionWorkflow"
  } ]
}

Import workflows

POST /api/workflows/v1/import

Parameters

Body Parameter
Name Description Schema Example

importWorkflows_request_inner required

List ([importWorkflows_request_inner])

Responses

Table 85. http response codes
Code Message Datatype

400

Bad request

401

Authentication required

403

Authorization failed, access forbidden

422

Validation failed

200

OK

Samples

Models

AccessRole

Access role

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

LocalizedString

null

permissionUrns optional

Urn identifiers for permissions this role provides

Size(max = 200, min = 0)
ContainsNoNulls
UrnCode(namespace = urn:code:permission, onlySyntax = false)

Set of [string]

null

AccessRolePersonAssignment

Access role assignment to a person

Field Name Description Validation Schema Example

accessRoleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

accessRoleName optional

LocalizedString

null

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personFirstNames optional

First names of the person this role is assigned to (only when reading)

[String]

null

personLastName optional

Last name of the person the role is assigned to (only when reading)

[String]

null

resourceType required

Type of access resource

NotNull

[String] enum course-unit, course-unit-realisation, study-module, degree-programme, mass-exam-session, open-university-product, organisation, education, person, global, other,

null

resourceId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

ActivateStudiesFrontpageComponentSetting

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

Address

Represents addresses for physical locations

Field Name Description Validation Schema Example

countryUrn required

Represents Uniform Resource Names for country names. Supported values available here

UrnCode(namespace = urn:code:country, onlySyntax = false)
NotNull

[String]

urn:code:country:*

isUserEditable optional

Set to false to prevent address from being edited in the user interface.

[Boolean]

null

type required

Address type, either GenericAddress or FinnishAttainment

[String]

null

AdministrativeReview

Administrative review for an application.

ValidAdministrativeReview

Field Name Description Validation Schema Example

result required

Result of the administrative review for the application.

NotNull

[String] enum REQUIREMENTS_MET, REQUIREMENTS_NOT_MET, REVIEW_NOT_PERFORMED,

null

reviewerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

reviewerTitle optional

LocalizedString

null

notes optional

Additional notes related to the review (not visible to the student)

Size(max = 8000, min = 1)

[String]

null

ApplicationAccount

Integration account description

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationName required

Name for the account, used in login

[String]

null

apiKey required

Hashed representation of the API key

[String]

null

AssessmentItemAttainment

Attainment of an assessment item, such as an exam. These are the basic attainments that are then later used to compose course unit and module attainments.

ValidSubstitution

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitRealisationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AssessmentItemAttainmentAllOf

Field Name Description Validation Schema Example

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitRealisationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate optional

The official date of the attainment

[date] date

null

AssessmentItemAttainmentPublic

Attainment of an assessment item, such as an exam. These are the basic attainments that are then later used to compose course unit and module attainments.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitRealisationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AssessmentItemSelection

Selection of an assessment item for a course unit in a study plan.

Field Name Description Validation Schema Example

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AssociatedStudy

Any associated studies attained in other educational institutions or degrees

Field Name Description Validation Schema Example

description required

Description of the associated study

[String]

null

credits required

Credits of the associated study

[BigDecimal]

null

attainmentLocation required

Represents Uniform Resource Names for educational institutions. Supported values available here

[String]

urn:code:educational-institution:*

associatedDegree required

Degree the associated study was part of

[String]

null

attainmentDate required

Attainment date of the associated study

[date] date

null

AttainableDegree

Information about attended degree

Field Name Description Validation Schema Example

degreeName optional

The name of the degree

Size(max = 1024, min = 0)

[String]

null

internationalInstitutionUrn required

Represents Uniform Resource Names for international institutions. Supported values available here

NotNull
UrnCode(namespace = urn:code:international-institution, onlySyntax = false)

[String]

urn:code:international-institution:*

AttainableDegreePublic

Information about attended degree

Field Name Description Validation Schema Example

degreeName optional

The name of the degree

[String]

null

internationalInstitutionUrn required

Represents Uniform Resource Names for international institutions. Supported values available here

[String]

urn:code:international-institution:*

AttainedQualification

Attained qualification of a person

ValidAttainedQualification

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

qualificationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
QualificationId

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
StudyRightId

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

ModuleGroupId

[String]

otm-123456

additionalInformation optional

Additional information to attach to the attained qualification

Size(max = 8000, min = 0)

[String]

null

associatedStudies optional

Any associated studies attained in other educational institutions or degrees

ContainsNoNulls

Set of AssociatedStudy

null

attainmentDate optional

The official date for the attainment of qualification

[date] date

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

attainmentMethod required

Indicates whether this attained qualification has been attained automatically or manually

NotNull

[String] enum AUTOMATIC, MANUAL,

null

credits optional

The amount of credits.

Min(value = 0)
Max(value = 999)

[BigDecimal]

null

attainmentIds optional

Ids of attainments that correspond to referenced qualification's requirement collection

AttainmentId
Size(max = 200, min = 0)
ContainsNoNulls

Set of [string]

null

childAttainedQualificationIds optional

Ids of child attained qualifications

AttainedQualificationId
Size(max = 200, min = 0)
ContainsNoNulls

Set of [string]

null

registrationDate optional

Date when this attained qualification was registered

[date] date

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

Attainment

Full attainment object, including the metadata

ValidRdiPoints

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate optional

[date] date

null

AttainmentGroupNode

An attainment group node is a grouping header text in the hierarchical structure of module attainments.

Field Name Description Validation Schema Example

type required

[String]

null

name required

LocalizedString

null

nodes required

Child attainment nodes

List of AttainmentNode

null

AttainmentGroupNodeAllOf

Field Name Description Validation Schema Example

name optional

LocalizedString

null

nodes optional

Child attainment nodes

List of AttainmentNode

null

AttainmentGroupNodePublic

An attainment group node is a grouping header text in the hierarchical structure of module attainments.

Field Name Description Validation Schema Example

type required

[String]

null

name required

LocalizedString

null

nodes required

Child attainment nodes

List of [AttainmentNode_Public]

null

AttainmentGroupNodePublicAllOf

Field Name Description Validation Schema Example

name optional

LocalizedString

null

nodes optional

Child attainment nodes

List of [AttainmentNode_Public]

null

AttainmentNode

Node in the attainment structure

Field Name Description Validation Schema Example

type required

[String]

null

AttainmentNodePublic

Node in the attainment structure

Field Name Description Validation Schema Example

type required

[String]

null

AttainmentPublic

Full attainment object, including the metadata

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate optional

[date] date

null

AttainmentReferenceNode

An attainment reference node is a real attainment node in the hierarchical structure of module attainments, as opposed to the attainment group node, which is just header information.

Field Name Description Validation Schema Example

type required

[String]

null

attainmentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AttainmentReferenceNodeAllOf

Field Name Description Validation Schema Example

attainmentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AttainmentReferenceNodePublic

An attainment reference node is a real attainment node in the hierarchical structure of module attainments, as opposed to the attainment group node, which is just header information.

Field Name Description Validation Schema Example

type required

[String]

null

attainmentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AttainmentWorkflowApplication

Application related to an AttainmentWorkflow.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AttainmentWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

AttainmentWorkflowDecision

Decision for AttainmentWorkflow.

Field Name Description Validation Schema Example

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approvedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approverTitle optional

LocalizedString

null

approvalDate required

Date of decision.

NotNull

[date] date

null

resolutionRationale optional

Rationale for this decision.

Size(max = 8000, min = 0)

[String]

null

type required

Workflow decision type

[String]

null

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

appealInstructions optional

Instructions how to appeal this decision

[String]

null

AttainmentWorkflowDecisionAllOf

Field Name Description Validation Schema Example

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

appealInstructions optional

Instructions how to appeal this decision

[String]

null

ClassifiedPersonInfo

Contains all student information which can be set as secret by student/staff.

Field Name Description Validation Schema Example

isPhoneNumberClassified optional

Defines if phone number is classified.

[Boolean]

null

isSecondaryEmailClassified optional

Defines if secondary email is classified.

[Boolean]

null

isPrimaryAddressClassified optional

Defines if primary address is classified.

[Boolean]

null

isSecondaryAddressClassified optional

Defines if secondary address is classified.

[Boolean]

null

isMunicipalityUrnClassified optional

Defines if municipality urn is classified.

[Boolean]

null

changedById optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

changedOn optional

When the last change was done

[Date] date-time

null

CollaborationInstitution

Institution an organisation collaborates with, especially intended for open university activity.

ValidCollaborationInstitution

Field Name Description Validation Schema Example

educationalInstitutionUrn required

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)
NotNull

[String]

urn:code:educational-institution:*

internationalInstitutionUrn optional

Represents Uniform Resource Names for international institutions. Supported values available here

UrnCode(namespace = urn:code:international-institution, onlySyntax = false)

[String]

urn:code:international-institution:*

CollaborationInstitutionPublic

Institution an organisation collaborates with, especially intended for open university activity.

Field Name Description Validation Schema Example

educationalInstitutionUrn required

Represents Uniform Resource Names for educational institutions. Supported values available here

[String]

urn:code:educational-institution:*

internationalInstitutionUrn optional

Represents Uniform Resource Names for international institutions. Supported values available here

[String]

urn:code:international-institution:*

CooperationNetworkRight

Cooperation network right within a study right

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

cooperationNetworkId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

CooperationNetworkId
NotNull

[String]

otm-123456

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

updateType required

Update type of the cooperation network right. MANUAL when granted manually, AUTOMATIC when granted and updated automatically through cooperation network target groups.

NotNull

[String] enum MANUAL, AUTOMATIC,

null

targetGroupUpdateDate optional

The date when this cooperation network right was granted. Defined only for automatically granted cooperation network rights.

[date] date

null

CooperationNetworkStatus

Co-operation network status for entities that are created or targeted through RIPA to a cooperation network university

Field Name Description Validation Schema Example

direction required

Cooperation network direction seen from SISU

NotNull

[String] enum INBOUND, OUTBOUND, NONE,

null

organisationTkCode optional

Organisation TK code used in CSC's Ristiinopiskelupalvelu. For OUTBOUND entities, organisationTkCode represents the organisation where this entity is going to be sent. For INBOUND entities, organisationTkCode represents the organisation this entity originated from.

[String]

null

outboundStatus optional

Co-operation network status for entities that are sent through RIPA to a cooperation network host university

[String] enum NOT_VALID, FORWARDED, RECORDED, REJECTED,

null

rejectionReason optional

LocalizedString

null

outboundStatusMessage optional

Status message further describing processing of OUTBOUND entity to other university

[String]

null

cooperationNetworkId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

universityOrgId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

homeStudyRightId optional

[String]

null

CooperationNetworkStatusPublic

Co-operation network status for entities that are created or targeted through RIPA to a cooperation network university

Field Name Description Validation Schema Example

direction required

Cooperation network direction seen from SISU

[String] enum INBOUND, OUTBOUND, NONE,

null

organisationTkCode optional

Organisation TK code used in CSC's Ristiinopiskelupalvelu. For OUTBOUND entities, organisationTkCode represents the organisation where this entity is going to be sent. For INBOUND entities, organisationTkCode represents the organisation this entity originated from.

[String]

null

outboundStatus optional

Co-operation network status for entities that are sent through RIPA to a cooperation network host university

[String] enum NOT_VALID, FORWARDED, RECORDED, REJECTED,

null

rejectionReason optional

LocalizedString

null

outboundStatusMessage optional

Status message further describing processing of OUTBOUND entity to other university

[String]

null

cooperationNetworkId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

universityOrgId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

homeStudyRightId optional

[String]

null

CourseUnitAttainment

Attainment of an course unit, typically (either automatically or by request of the student) composed of assessment item attainments when all the required ones have been completed.

ValidSubstitution

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemAttainmentIds optional

The IDs of assessment item attainments that this course unit attainment groups together.

List of [string]

null

resolutionRationale optional

Rationale for abnormal grade.

[String]

null

evaluationCriteria optional

LocalizedString

null

CourseUnitAttainmentAllOf

Field Name Description Validation Schema Example

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemAttainmentIds optional

The IDs of assessment item attainments that this course unit attainment groups together.

List of [string]

null

resolutionRationale optional

Rationale for abnormal grade.

[String]

null

evaluationCriteria optional

LocalizedString

null

attainmentDate optional

The official date of the attainment

[date] date

null

CourseUnitAttainmentPublic

Attainment of an course unit, typically (either automatically or by request of the student) composed of assessment item attainments when all the required ones have been completed.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemAttainmentIds optional

The IDs of assessment item attainments that this course unit attainment groups together.

List of [string]

null

resolutionRationale optional

Rationale for abnormal grade.

[String]

null

evaluationCriteria optional

LocalizedString

null

CourseUnitSelection

Selection of a course unit into a module in a study plan. Possibly also selecting a completion method. Possibly also indicating that the course unit is a substitute or is being substituted.

Field Name Description Validation Schema Example

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

completionMethodId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

substitutedBy optional

Set of [string]

null

substituteFor optional

Set of SubstituteFor

null

plannedPeriods optional

Set of [string]

null

CreateAttainmentRequest

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitRealisationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemAttainmentIds optional

The IDs of assessment item attainments that this course unit attainment groups together.

List of [string]

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

evaluationCriteria optional

LocalizedString

null

name required

LocalizedString

null

studyLevelUrn required

Supported values available here

[String]

urn:code:study-level:*

courseUnitTypeUrn required

Supported values available here

[String]

urn:code:course-unit-type:*

code required

Custom code of the custom module attainment

[String]

null

customStudyDraftId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of AttainmentNode

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of EmbeddedModule

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn required

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn required

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

ValidInternationalContractualDegree

InternationalContractualDegree

null

CreditRange

Range of acceptable credit values. Leaving max unspecified indicates an upwards unbound range.

Field Name Description Validation Schema Example

min required

minimum acceptable value

NotNull
Min(value = 0)

[BigDecimal]

null

max optional

maximum acceptable value

[BigDecimal]

null

CreditTransferInfo

Credit transfer information for attainment that has been transferred

ValidCreditTransferInfo

Field Name Description Validation Schema Example

educationalInstitutionUrn required

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)
NotNull

[String]

urn:code:educational-institution:*

internationalInstitutionUrn optional

Represents Uniform Resource Names for international institutions. Supported values available here

UrnCode(namespace = urn:code:international-institution, onlySyntax = false)

[String]

urn:code:international-institution:*

organisation optional

Description of the university or organisation if no suitable internationalInstitutionUrn can be given

Size(max = 8000, min = 0)

[String]

null

creditTransferDate required

The date when this credit was transferred

NotNull

[date] date

null

CreditTransferInfoPublic

Credit transfer information for attainment that has been transferred

Field Name Description Validation Schema Example

educationalInstitutionUrn required

Represents Uniform Resource Names for educational institutions. Supported values available here

[String]

urn:code:educational-institution:*

internationalInstitutionUrn optional

Represents Uniform Resource Names for international institutions. Supported values available here

[String]

urn:code:international-institution:*

organisation optional

Description of the university or organisation if no suitable internationalInstitutionUrn can be given

[String]

null

creditTransferDate required

The date when this credit was transferred

[date] date

null

CustomAttainmentWorkflow

Workflow for granting a custom attainment.

ValidModuleReference

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

name required

Descriptive name of the workflow

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher required

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale optional

Application rationale, why the student wishes to gain the credits

[String]

null

attainmentDescription optional

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits required

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomAttainmentWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

name optional

Descriptive name of the workflow

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher optional

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale optional

Application rationale, why the student wishes to gain the credits

[String]

null

attainmentDescription optional

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits optional

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomAttainmentWorkflowApplication

Application related to CustomAttainmentWorkflow.

ValidModuleReference

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

name required

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher required

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale required

Application rationale, why the student wishes to gain the credits

[String]

null

attainmentDescription required

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits required

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomAttainmentWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

name optional

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher optional

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale optional

Application rationale, why the student wishes to gain the credits

[String]

null

attainmentDescription optional

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits optional

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomCourseUnitAttainment

Attainment of a personalized entity of studies that can be proposed to be included in studies with no direct substitutions, eg. courses completed abroad.

ValidAttainmentDate [Active]

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

name required

LocalizedString

null

studyLevelUrn required

Supported values available here

[String]

urn:code:study-level:*

courseUnitTypeUrn required

Supported values available here

[String]

urn:code:course-unit-type:*

code required

Custom code of the attainment

[String]

null

customStudyDraftId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

CustomCourseUnitAttainmentAllOf

Field Name Description Validation Schema Example

name optional

LocalizedString

null

studyLevelUrn optional

Supported values available here

[String]

urn:code:study-level:*

courseUnitTypeUrn optional

Supported values available here

[String]

urn:code:course-unit-type:*

code optional

Custom code of the attainment

[String]

null

customStudyDraftId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

attainmentDate optional

The official date of the attainment

[date] date

null

CustomCourseUnitAttainmentPublic

Attainment of a personalized entity of studies that can be proposed to be included in studies with no direct substitutions, eg. courses completed abroad.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

name required

LocalizedString

null

studyLevelUrn required

Supported values available here

[String]

urn:code:study-level:*

courseUnitTypeUrn required

Supported values available here

[String]

urn:code:course-unit-type:*

code required

Custom code of the attainment

[String]

null

customStudyDraftId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

CustomCourseUnitAttainmentSelection

Selection of custom course unit attainment in a study plan.

Field Name Description Validation Schema Example

customCourseUnitAttainmentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomModuleAttainment

A larger personalized part of custom studies, consisting of custom course unit attainments.

ValidAttainmentDate [Active]

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

code required

Custom code of the custom module attainment

[String]

null

name required

LocalizedString

null

nodes optional

The IDs of custom course unit and/or custom module attainment nodes that this module groups together.

List of AttainmentNode

null

CustomModuleAttainmentAllOf

Field Name Description Validation Schema Example

code optional

Custom code of the custom module attainment

[String]

null

name optional

LocalizedString

null

nodes optional

The IDs of custom course unit and/or custom module attainment nodes that this module groups together.

List of AttainmentNode

null

attainmentDate optional

The official date of the attainment

[date] date

null

CustomModuleAttainmentPublic

A larger personalized part of custom studies, consisting of custom course unit attainments.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

code required

Custom code of the custom module attainment

[String]

null

name required

LocalizedString

null

nodes optional

The IDs of custom course unit and/or custom module attainment nodes that this module groups together.

List of [AttainmentNode_Public]

null

CustomModuleAttainmentPublicAllOf

Field Name Description Validation Schema Example

code optional

Custom code of the custom module attainment

[String]

null

name optional

LocalizedString

null

nodes optional

The IDs of custom course unit and/or custom module attainment nodes that this module groups together.

List of [AttainmentNode_Public]

null

attainmentDate optional

The official date of the attainment

[date] date

null

CustomModuleAttainmentSelection

Selection of a custom module attainment in a study plan.

Field Name Description Validation Schema Example

customModuleAttainmentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

CustomModuleContentWorkflow

Workflow for approving module content that differs from the one determined by the rule of the module.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

CustomModuleContentWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections optional

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections optional

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections optional

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections optional

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts optional

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

CustomModuleContentWorkflowApplication

Application related to CustomModuleContentWorkflow.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

CustomModuleContentWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

educationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections optional

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections optional

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections optional

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections optional

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts optional

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

CustomStudyDraft

Represents studies (usually course units) the student has planned to perform, possibly in another educational institution. A custom study draft (i.e. "opintoluonnos") can be used as a basis for creating either a prior learning inclusion application or a custom attainment application.

Field Name Description Validation Schema Example

id required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

The name of this study draft (e.g. the name of a course unit the student has planned to attend in some other educational institution).

NotEmpty
Size(max = 100, min = 0)
ValidSanitized

[String]

null

description required

A description of what the student has planned to study (e.g. the description and/or learning outcomes of a course unit).

NotEmpty
Size(max = 8000, min = 0)

[String]

null

location required

Where the student is planning to perform these studies (e.g. the name of the university).

NotEmpty
Size(max = 255, min = 0)

[String]

null

credits required

How many credits the student is planning to attain.

NotNull
Min(value = 0)
Max(value = 999)

[BigDecimal]

null

plannedPeriods required

The period(s) during which the student has planned to perform these studies.

NotNull
ContainsNoNulls

Set of [string]

null

DegreeProgrammeAttainment

Attainment of degree programme.

ValidModuleReference

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this degree programme attainment groups together.

List of AttainmentNode

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of EmbeddedModule

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn required

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn required

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

ValidInternationalContractualDegree

InternationalContractualDegree

null

DegreeProgrammeAttainmentAllOf

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this degree programme attainment groups together.

List of AttainmentNode

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of EmbeddedModule

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn optional

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

ValidInternationalContractualDegree

InternationalContractualDegree

null

attainmentDate optional

The official date of the attainment

[date] date

null

DegreeProgrammeAttainmentApplicationAnswer

An answer to one DegreeProgrammeAttainmentApplicationQuestion.

ValidDegreeProgrammeAttainmentApplicationAnswer

Field Name Description Validation Schema Example

questionId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

question required

LocalizedString

null

guidance optional

LocalizedMarkupString

null

required optional

Is it required to answer this question. Copied from the question object.

[Boolean]

null

answer optional

An answer to question

Size(max = 1024, min = 0)
ValidSanitized

[String]

null

DegreeProgrammeAttainmentPublic

Attainment of degree programme.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this degree programme attainment groups together.

List of [AttainmentNode_Public]

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of [EmbeddedModule_Public]

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn required

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn required

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

[InternationalContractualDegree_Public]

null

DegreeProgrammeAttainmentPublicAllOf

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this degree programme attainment groups together.

List of [AttainmentNode_Public]

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of [EmbeddedModule_Public]

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn optional

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

[InternationalContractualDegree_Public]

null

attainmentDate optional

The official date of the attainment

[date] date

null

DegreeProgrammeAttainmentWorkflow

Workflow for degree programme attainment and graduation.

ValidModuleReference

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding the workflow.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when workflow is related to last phase of education. Should be null otherwise.

[Boolean]

null

newWorkflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

DegreeProgrammeAttainmentWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

degreeDeliveryMethod optional

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding the workflow.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when workflow is related to last phase of education. Should be null otherwise.

[Boolean]

null

newWorkflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

DegreeProgrammeAttainmentWorkflowApplication

Application related to DegreeProgrammeAttainmentWorkflow.

ValidModuleReference

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding graduation application given by student.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when application is related to last phase of education. Should be null otherwise.

[Boolean]

null

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

DegreeProgrammeAttainmentWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

degreeDeliveryMethod optional

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding graduation application given by student.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when application is related to last phase of education. Should be null otherwise.

[Boolean]

null

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

DisclosureAuthorization

The authorization to use personal information for example for marketing purposes. These are opt in, so authorization must be granted. If authorization does not exist it is not authorized to hand data over to third parties.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

privatePersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

disclosureCategoryId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

DisclosureAuthorizationCategoryId

[String]

otm-123456

authorized required

Is the use of person information authorized or not for the purpose of the category

NotNull

[Boolean]

null

changedByPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

EducationPhaseProgress

Represents the student's progress for an education phase based on credit accumulation

Field Name Description Validation Schema Example

degreeProgrammeId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

DegreeProgrammeId
NotNull

[String]

otm-123456

phaseName required

LocalizedString

null

targetCredits required

CreditRange

null

attainedCredits required

Amount of credits the student has attained for the education phase

NotNull
Min(value = 0)

[BigDecimal]

null

EmbeddedModule

Embedded modules for non-graded study modules that are not attained in themselves

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

EmbeddedModulePublic

Embedded modules for non-graded study modules that are not attained in themselves

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

EnrolmentConstraint

Describes the CourseUnitRealisation enrolment constraints affecting a student.

Field Name Description Validation Schema Example

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
AssessmentItemId

[String]

otm-123456

maxNumberOfEnrolments optional

Maximum number of CourseUnitRealisations the student may enroll to get the AssessmentItemAttainment. If not defined, a student may enrol to as many realisations they want during the validityPeriod of the purchased product

Min(value = 0)

[Integer] int32

null

allowedCourseUnitRealisationIds optional

All CourseUnitRealisations the student may enroll. If empty, student cannot enroll. If null, student may enroll to any CourseUnitRealisation of this AssessmentItem during the validityPeriod

ContainsNoNulls
CourseUnitRealisationId

Set of [string]

null

EnrolmentRight

EnrolmentRight defines the (separately from StudyRights) completion method and CourseUnitRealisations that the student is allowed to participate

ValidEntityWithEnrolmentConstraints(completionMethodType = [Lfi.helsinki.otm.common.model.StudyType;@2bccdca4)

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId
NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

CourseUnitId
NotNull [Active, Legacy]

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

CourseUnitGroupId
NotNull [Active, Legacy]

[String]

otm-123456

changeLog required

List of EnrolmentRightChangeLogItems that form the change log for the enrolmentRight

ContainsNoNulls
NotNull

List of EnrolmentRightChangeLogItem

null

completionMethodId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

state required

The states in which EnrolmentRights may be.

NotNull

[String] enum ACTIVATED, CANCELLED,

null

openUniversityCartId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

OpenUniversityCartId

[String]

otm-123456

openUniversityCartItemId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

openUniversityProductId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

enrolmentConstraints optional

If there are any enrolment constraints in to which CourseUnitRealisations the student may enrol or how many times, that information is here. Optional when type = SUBSTITUTION.

ContainsNoNulls

List of EnrolmentConstraint

null

cancellationDate optional

Date this enrolment right was cancelled

[date] date

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

type required

Types of EnrolmentRights.

NotNull

[String] enum CUR_ENROLMENT, SUBSTITUTION,

null

EnrolmentRightChangeLogItem

EnrolmentRightChangeLogItem contains reason for any changes made to the enrolment right.

Field Name Description Validation Schema Example

modificationTime required

Date and time of the enrolment right modification

NotNull

[Date] date-time

null

changedByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

changeType required

Defines the type of change made

NotNull

[String] enum EDIT, CANCEL, AUTOMATED_CANCEL,

null

changeMessage optional

ChangeMessage is the reason for the change as given by the user

Size(max = 1024, min = 0)

[String]

null

ExportAssigneeIdResultStudyRight

Container for results of export api calls. This version expects the entity to be assignable to a person and returns, not entities themselves, but the assigneeIds. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

personIds optional

The Ids of the assignees.

List of [string]

null

ExportIdResultOtmIdStudyRight

Container for results of export api calls. This version expects the entity to have an ID and returns, not entities themselves, but the ids, acquired by Entity::getId(). Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'ids' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

ids optional

The Ids of the entities.

List of [string]

null

ExportResultAccessRole

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of AccessRole

null

ExportResultApplicationAccount

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of ApplicationAccount

null

ExportResultAttainedQualification

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of AttainedQualification

null

ExportResultAttainment

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of [createAttainment_request]

null

ExportResultDisclosureAuthorization

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of DisclosureAuthorization

null

ExportResultGraduation

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of Graduation

null

ExportResultGrant

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of Grant

null

ExportResultMobilityPeriod

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of MobilityPeriod

null

ExportResultPassport

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of Passport

null

ExportResultPersonDataChange

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of PersonDataChange

null

ExportResultPersonGroup

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of [importPersonGroups_request_inner]

null

ExportResultPrivatePerson

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of PrivatePerson

null

ExportResultStudentPayment

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of [importStudentPayments_request_inner]

null

ExportResultStudyRight

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of StudyRight

null

ExportResultStudyRightPrimality

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of StudyRightPrimality

null

ExportResultStudyRightTermRegistrations

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of StudyRightTermRegistrations

null

ExportResultTermRegistrationPeriod

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of TermRegistrationPeriod

null

ExportResultThesis

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of Thesis

null

ExportResultTuitionFeeObligationPeriod

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of TuitionFeeObligationPeriod

null

ExportResultUserSettings

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of UserSettings

null

ExportResultWorkflow

Container for results of export api calls. Specifies a continuation key for next similar api call with 'greatestOrdinal', and 'hasMore' tells if there are, at this time, any continuation data to be had. The field 'entities' contains the actual data.

Field Name Description Validation Schema Example

greatestOrdinal optional

The modification ordinal number of the last modification whose corresponding entity data is included in this result.

[Long] int64

null

hasMore optional

Is there more data to be had?

[Boolean]

null

entities optional

The actual data.

List of [importWorkflows_request_inner]

null

FinnishAddress

Represents addresses for physical locations in Finland

Field Name Description Validation Schema Example

countryUrn required

Represents Uniform Resource Names for country names. Supported values available here

UrnCode(namespace = urn:code:country, onlySyntax = false)
NotNull

[String]

urn:code:country:*

isUserEditable optional

Set to false to prevent address from being edited in the user interface.

[Boolean]

null

type required

Address type, either GenericAddress or FinnishAttainment

[String]

null

streetAddress optional

Street address part of the address

[String]

null

postalCode optional

Postal code of the address

[String]

null

city optional

City of the address

[String]

null

FinnishAddressAllOf

Field Name Description Validation Schema Example

streetAddress optional

Street address part of the address

[String]

null

postalCode optional

Postal code of the address

[String]

null

city optional

City of the address

[String]

null

FrontpageComponentSetting

Contains the settings and preferences for a user.

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

GenericAddress

Represents addresses for physical locations with unstructured notation

Field Name Description Validation Schema Example

countryUrn required

Represents Uniform Resource Names for country names. Supported values available here

UrnCode(namespace = urn:code:country, onlySyntax = false)
NotNull

[String]

urn:code:country:*

isUserEditable optional

Set to false to prevent address from being edited in the user interface.

[Boolean]

null

type required

Address type, either GenericAddress or FinnishAttainment

[String]

null

address optional

The whole address excluding the country

[String]

null

GenericAddressAllOf

Field Name Description Validation Schema Example

address optional

The whole address excluding the country

[String]

null

GetAttainments200ResponseInner

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitRealisationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

assessmentItemAttainmentIds optional

The IDs of assessment item attainments that this course unit attainment groups together.

List of [string]

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

evaluationCriteria optional

LocalizedString

null

name required

LocalizedString

null

studyLevelUrn required

Supported values available here

[String]

urn:code:study-level:*

courseUnitTypeUrn required

Supported values available here

[String]

urn:code:course-unit-type:*

code required

Custom code of the custom module attainment

[String]

null

customStudyDraftId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of [AttainmentNode_Public]

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of [EmbeddedModule_Public]

null

acceptorOrganisationIds optional

The IDs of organisation(s) who are responsible for giving the attainment

Set of [string]

null

educationClassificationUrn required

Supported values available here

[String]

urn:code:education-classification:*

secondaryEducationClassificationUrn optional

Supported values available here

[String]

urn:code:education-classification:*

degreeTitleUrn required

Supported values available here

[String]

urn:code:degree-title:*

honoraryTitleUrn optional

Supported values availablehere

[String]

urn:code:honorary-title:*

internationalContractualDegree optional

[InternationalContractualDegree_Public]

null

GradeAverage

A result of grade average calculation.

Field Name Description Validation Schema Example

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

value optional

Calculated average numerical grade.

[BigDecimal]

null

totalIncludedCredits required

Sum of credits that were included in calculation.

NotNull

[BigDecimal]

null

method required

The grade average calculation method/formula.

NotNull

[String] enum COURSE_UNIT_ARITHMETIC_MEAN_WEIGHTING_BY_CREDITS, COURSE_UNIT_AND_EMPTY_MODULE_ARITHMETIC_MEAN_WEIGHTED_BY_CREDITS, ARITHMETIC_MEAN_WEIGHTING_BY_CREDITS,

null

GradeAveragePublic

A result of grade average calculation.

Field Name Description Validation Schema Example

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

value optional

Calculated average numerical grade.

[BigDecimal]

null

totalIncludedCredits required

Sum of credits that were included in calculation.

[BigDecimal]

null

method required

The grade average calculation method/formula.

[String] enum COURSE_UNIT_ARITHMETIC_MEAN_WEIGHTING_BY_CREDITS, COURSE_UNIT_AND_EMPTY_MODULE_ARITHMETIC_MEAN_WEIGHTED_BY_CREDITS, ARITHMETIC_MEAN_WEIGHTING_BY_CREDITS,

null

Graduation

Contains information of graduation and degree

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

degreeProgrammeAttainmentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
AttainmentId

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
StudyRightId

[String]

otm-123456

graduationDate required

Date of graduation

NotNull

[date] date

null

signatories required

Signers of the degree

ContainsNoNulls
NotNull
Size(max = 2, min = 1)

List of Signatory

null

printLanguageUrns required

Language for printing the degree

ContainsNoNulls
Size(max = 200, min = 1)
UrnCode(namespace = urn:code:official-language, onlySyntax = false)

List of [string]

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

NotNull

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

[PrivatePerson_secondaryAddress]

null

misregistration required

If true, this is a misregistration, possibly replaced by a later graduation

[Boolean]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when graduation is related to last phase of education. Should be null otherwise.

[Boolean]

null

Grant

Represents a grant (apuraha) for student

FieldsNotNullWhenConditionTrue(condition = cancelled == true, fields = [Ljava.lang.String;@7b370478)

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

amount required

The amount of this grant

NotNull
Min(value = 0)

[BigDecimal]

null

grantTypeUrn required

Universal resource name for Grant type. Supported values available here

NotNull
UrnCode(namespace = urn:code:grant-type, onlySyntax = false)

[String]

urn:code:grant-type:*

studyTerm required

StudyTermLocator

null

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

registrationDate required

The date when this grant was registered

NotNull

[date] date

null

grantedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
OrganisationId

[String]

otm-123456

grantedDate optional

The date when this grant was given

[date] date

null

cancelled required

Is the grant cancelled

[Boolean]

null

cancelledBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

cancelledDate optional

The date when this grant is cancelled

[date] date

null

cancellationReason optional

The reason why this grant was cancelled

Size(max = 8000, min = 0)

[String]

null

ImportPersonGroupsRequestInner

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

LocalizedString

null

description optional

LocalizedString

null

updateType required

Manual groups must be updated by an administrator manually, while automatic groups are updated by running a student search periodically.

NotNull

[String] enum MANUAL, AUTOMATIC,

null

membershipUpdateTime optional

The time when memberships of this group was updated. Used only when updateType is AUTOMATIC.

[Date] date-time

null

membershipCheckTime optional

The time when memberships of this group was checked. Used only when updateType is AUTOMATIC.

[Date] date-time

null

responsibilityInfos required

Persons or roles in a responsibility relation to this group

NotNull [Active]
Size(max = 200, min = 0)
ContainsNoNulls

Set of PersonWithGroupResponsibilityInfoType

null

personQueries optional

List of conditions (joined by OR) for checking persons possible membership in this group. Unnecessary for MANUAL updateType.

ContainsNoNulls
Size(max = 20, min = 0)

List of PersonQuery

null

validMemberships optional

Number of valid memberships in group (read-only, only for group search)

[Integer] int32

null

type required

Group type

[String]

null

ImportStudentPaymentsRequestInner

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

invalidated required

Is the payment invalidated

[Boolean]

null

invalidationRationale optional

Rationale for the invalidation of the payment, required if the payment is invalidated

Size(max = 8000, min = 0)

[String]

null

invalidatedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

invalidationDate optional

Date of which the payment was invalidated

[date] date

null

paymentAmount required

Amount of the payment in euros

NotNull
Min(value = 0)

[BigDecimal]

null

paymentDate optional

Date on which the payment was made

[date] date

null

registeredBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

source required

Source for payment creation, currently either PERSON or OILI

NotNull

[String] enum PERSON, OILI,

null

registrationDate required

Registration date for payment

NotNull

[date] date

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyYearStartYear required

Study year which this payment is registered

NotNull

[Integer] int32

null

studyTerm optional

StudyTermLocator

null

type required

Defines the type of payment made by a student.

NotNull

[String] enum OILI_PAYMENT, TUITION_FEE_PAYMENT,

null

paymentCategoryId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

orderNumber optional

Order number for this payment

[String]

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

ImportWorkflowsRequestInner

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

name required

Descriptive name of the workflow

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher required

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale optional

Additional info related to how the student plans to finish his/her studies

[String]

null

attainmentDescription optional

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits required

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

planContent optional

ModuleContent

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding the workflow.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when workflow is related to last phase of education. Should be null otherwise.

[Boolean]

null

newWorkflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

priorLearnings optional

List of all prior learnings that should be considered within this workflow.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot required

Plan

null

studyRightValidity required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this workflow was created

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the workflow was created

List of TermRegistration

null

usedAttendanceTerms required

The amount of used attendance terms at the time the workflow was created

[Integer] int32

null

usedAbsenceTerms required

The amount of used absence terms at the time the workflow was created

[Integer] int32

null

usedStatutoryAbsenceTerms required

The amount of used statutory absence terms at the time the workflow was created

[Integer] int32

null

termsWithoutRegistration required

The amount of study terms without a term registration at the time the workflow was created

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the workflow was created

Set of [string]

null

phase1Progress required

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms to be granted

[Integer] int32

null

delayRationale optional

Additional info related to why the studies have been delayed

[String]

null

InternationalContractualDegree

Information about the used international contractual degree agreement

ValidInternationalContractualDegree

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

internationalContractualDegreeAgreementId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
InternationalContractualDegreeAgreementId

[String]

otm-123456

attainableDegrees required

Information about attended degrees

NotNull
Size(max = 200, min = 1)
ContainsNoNulls

List of AttainableDegree

null

InternationalContractualDegreePublic

Information about the used international contractual degree agreement

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

internationalContractualDegreeAgreementId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainableDegrees required

Information about attended degrees

List of [AttainableDegree_Public]

null

LearningOpportunitySelectionPath

One possible selection path in education structure.

Field Name Description Validation Schema Example

educationPhase1GroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationPhase1ChildGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationPhase2GroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationPhase2ChildGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

LocalDateRange

Date interval as a semi-open interval, start inclusive, end exclusive. If both start date and end date are null, range covers any possible date.

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

Field Name Description Validation Schema Example

startDate optional

Start date, inclusive. If null, there is no explicit start date, and is same as MIN

[date] date

null

endDate optional

End date, exclusive. If null, the range is never-ending i.e. is same as MAX

[date] date

null

LocalizedMarkupString

A map <langCode, value> of HTML formatted strings containing localized versions of a text: {"fi": "Päivää", "en": "Hello"}. Only limited set of HTML formatting tags are allowed: <ol>, <li>, <ul>, <h5>, <h6>, <br>, <p>, <sup>, <sub>, <b>, <i>, <u>, and <a href='…​'>, <a href='…​' target='_blank'>. <strong> is converted to <b>, and <em> is converted to <i>. <h1>, <h2>, <h3> and <h4> are converted to <h5>. <span style='text-decoration: underline'> is converted to <u>

Field Name Description Validation Schema Example

fi optional

Finnish version

[String]

<b>Finnish</b> version

sv optional

Swedish version

[String]

<b>Swedish</b> version

en optional

English version

[String]

<b>English</b> version

LocalizedString

A map <langCode, value> of plain strings containing localized versions of a text

Field Name Description Validation Schema Example

fi optional

Finnish version

[String]

Finnish version

sv optional

Swedish version

[String]

Swedish version

en optional

English version

[String]

English version

MobilityPeriod

Mobility period represents the inbound or outbound movement of exchange students.

ValidMobilityPeriod

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
StudyRightId

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

mobilityDirection required

The direction of mobility period in relation to the university that controls this data.

NotNull

[String] enum INBOUND, OUTBOUND,

null

activityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

phase required

The phase of the study right.

NotNull

[String] enum PHASE1, PHASE2,

null

mobilityProgramUrn required

Represents Uniform Resource Names for mobility programmes. Supported values available here

NotNull
UrnCode(namespace = urn:code:mobility-program, onlySyntax = false)

[String]

urn:code:mobility-program:*

mobilityProgramDescription optional

Description of the mobility program

Size(max = 8000, min = 0)

[String]

null

mobilityTypeUrn required

Represents Uniform Resource Names for mobility types. Supported values available here

NotNull
UrnCode(namespace = urn:code:mobility-type, onlySyntax = false)

[String]

urn:code:mobility-type:*

countryUrn required

Represents Uniform Resource Names for country names. Supported values available here

NotNull
UrnCode(namespace = urn:code:country, onlySyntax = false)

[String]

urn:code:country:*

internationalInstitutionUrn optional

Represents Uniform Resource Names for international institutions. Supported values available here

UrnCode(namespace = urn:code:international-institution, onlySyntax = false)

[String]

urn:code:international-institution:*

organisation optional

Description of the university or organisation if no suitable internationalInstitutionUrn can be given

Size(max = 8000, min = 0)

[String]

null

mobilityStudyRightTypeUrn optional

Supported values available here

UrnCode(namespace = urn:code:mobility-study-right-type, onlySyntax = false)

[String]

urn:code:mobility-study-right-type:*

virtualMobilityType optional

Type of a mobility period.

[String] enum None, RemoteAttendance, BlendedAttendance,

null

isCancelled optional

Indicates, whether mobility program is cancelled. This flag is used, when user wants to cancelthe mobilityPeriod

[Boolean]

null

ModuleAttainment

Attainment of module, representing some larger part of the degree, such as minor studies.

ActiveModuleId [Active]

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

NotNull

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

NotNull
UrnCode(namespace = , onlySyntax = false)

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls
NotEmpty

Set of OrganisationRoleShareBase

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

NotNull

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

Size(max = 1024, min = 1)

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

NotNull

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

GradeScaleId
NotNull

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

NotNull

[Integer] int32

null

gradeAverage optional

GradeAverage

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

Size(max = 1024, min = 1)

[String]

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

creditTransferInfo optional

ValidCreditTransferInfo

CreditTransferInfo

null

cooperationNetworkStatus optional

CooperationNetworkStatus

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

ValidCollaborationInstitution

CollaborationInstitution

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

EnrolmentRightId

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of AttainmentNode

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of EmbeddedModule

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

ModuleAttainmentAllOf

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of AttainmentNode

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of EmbeddedModule

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

attainmentDate optional

The official date of the attainment

[date] date

null

ModuleAttainmentPublic

Attainment of module, representing some larger part of the degree, such as minor studies.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

verifierPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

registrationDate required

The date when attainment was registered into the system

[date] date

null

expiryDate optional

The date when attainment will expire

[date] date

null

attainmentLanguageUrn required

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

acceptorPersons required

Employee(s) who are responsible for giving the attainment

Set of [PersonWithAttainmentAcceptorType_Public]

null

organisations required

Organisations responsible for this attainment in various ways and fractions. Typically the same list as in the related CourseUnitRealisation

Set of [OrganisationRoleShareBase_Public]

null

state required

ATTAINED means that the study has been attained, but is not included in other attainments.

INCLUDED means that studies completed elsewhere or learning gained elsewhere is included in the degree, for instance, as elective studies. Although inclusion does not require correspondence of contents, the level of the included studies shall correspond to the degree requirements in force.

Substitution means compensating compulsory studies included in the degree requirements with studies completed elsewhere or with other learning gained elsewhere. Substitution requires that the contents and level of the studies or learning gained elsewhere correspond to those of the studies substituted for. In addition, substitution requires that the extent of the studies or learning gained elsewhere correspond to that of the studies substituted for. FAILED means that study was not attained.

[String] enum ATTAINED, INCLUDED, SUBSTITUTED, FAILED,

null

misregistration required

If true, this is a misregistration, replaced by a later attainment

[Boolean]

null

misregistrationRationale optional

Rationale for misregistration

[String]

null

primary required

Indicates whether this is the primary attainment. There may be multiple attainments, for example if the student has tried to increase the grade. Primary attainment is not necessarily the latest attainment, as an earlier grade may be better than a later try. There can be only one primary attainment per student related to a module or a course unit cloud, or an attainment item.

[Boolean]

null

credits required

The amount of credits.

[BigDecimal]

null

studyWeeks optional

How many study weeks the credits of the attainment represents. This must be defined only for old attainments that used study weeks, in order to keep the original study week stored.

[BigDecimal]

null

gradeScaleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

gradeId required

The index of the grade, within the grade scale, that represents the grade for this attainment

[Integer] int32

null

gradeAverage optional

[GradeAverage_Public]

null

additionalInfo optional

LocalizedString

null

administrativeNote optional

Administrative note.

[String]

null

studyFieldUrn optional

Supported values available here

[String]

urn:code:study-field:*

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleContentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creditTransferInfo optional

[CreditTransferInfo_Public]

null

cooperationNetworkStatus optional

[CooperationNetworkStatus_Public]

null

rdiCredits optional

Research, development and innovation points (AMK)

[BigDecimal]

null

collaborationInstitution optional

[CollaborationInstitution_Public]

null

enrolmentRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

type required

One of AssessmentItemAttainment, CourseUnitAttainment, CustomCourseUnitAttainment, ModuleAttainment, CustomModuleAttainment, DegreeProgrammeAttainment

[String]

null

studentApplicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

attainmentDate required

The official date of the attainment

[date] date

null

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of [AttainmentNode_Public]

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of [EmbeddedModule_Public]

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

ModuleAttainmentPublicAllOf

Field Name Description Validation Schema Example

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

nodes optional

The IDs of nodes that this module attainment groups together.

List of [AttainmentNode_Public]

null

embeddedModules optional

Embedded modules for non-graded modules included in the attainment

List of [EmbeddedModule_Public]

null

resolutionRationale optional

An optional rationale describing why contents of the module attainment do not comply with module rules or why grade does not equal weighted average grade of.

[String]

null

attainmentDate optional

The official date of the attainment

[date] date

null

ModuleAttainmentWorkflow

Workflow for approving a module attainment.

ValidModuleAttainmentWorkflow

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

ModuleAttainmentWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

ModuleAttainmentWorkflowApplication

Application related to ModuleAttainmentWorkflow.

ValidModuleReference

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

ModuleAttainmentWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planContent optional

ModuleContent

null

ModuleContent

Defines the content that is included in module attainment.

Field Name Description Validation Schema Example

courseUnitSelections optional

Selected course units

ContainsNoNulls

List of CourseUnitSelection

null

moduleSelections optional

Selected modules

EntityWithRuleId
ContainsNoNulls

List of ModuleSelection

null

customCourseUnitAttainmentSelections optional

Selected custom course unit attainments

ContainsNoNulls

List of CustomCourseUnitAttainmentSelection

null

customModuleAttainmentSelections optional

Selected custom module attainments

ContainsNoNulls

List of CustomModuleAttainmentSelection

null

customStudyDrafts optional

Selected custom study drafts

ContainsNoNulls

List of CustomStudyDraft

null

ModuleContentWorkflowApplication

An application related to ModuleContentWorkflow

ValidModuleContentWorkflowApplication

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

ModuleContentWorkflowDecision

Decision for ModuleContentWorkflow.

Field Name Description Validation Schema Example

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approvedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approverTitle optional

LocalizedString

null

approvalDate required

Date of decision.

NotNull

[date] date

null

resolutionRationale optional

Rationale for this decision.

Size(max = 8000, min = 0)

[String]

null

type required

Workflow decision type

[String]

null

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

conditionalApprovalTerms optional

Conditional approval terms for this approval

[String]

null

ModuleContentWorkflowDecisionAllOf

Field Name Description Validation Schema Example

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

conditionalApprovalTerms optional

Conditional approval terms for this approval

[String]

null

ModuleSelection

Selection of a module into another module in a study plan.

Field Name Description Validation Schema Example

moduleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personalisedModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

OiliDocument

An OILI document is created for each student registration in OILI. The OILI document and its fields are described primarily at https://wiki.eduuni.fi/display/cscoili/OILI-dokumentti (requires an eDuuni account) and also from the Sisu point of view at https://confluence.funidata.fi/pages/viewpage.action?pageId=16123757. This class doesn't contain all fields in the document, only the ones Sisu is interested in.

Field Name Description Validation Schema Example

hakemus required

OiliHakemus

null

henkilo required

OiliHenkilo

null

ilmoittautumiset optional

Study term registrations done via OILI. Maps to TermRegistration objects. NOTE: registrations done via Opintopolku are in the 'hakemus.ilmoittautumiset' field, but OILI registrations take precedence if both exist.

List of OiliIlmoittautuminen

null

meta required

OiliMeta

null

opiskeluoikeudet required

Registration related study rights; not available for new students; their corresponding information is in the "hakemus" field

NotNull [ContinuingStudent]
Null [NewStudent]

List of OiliOpiskeluOikeus

null

maksutiedot optional

OiliMaksutiedot

null

OiliHakemus

A student's university application information. Only available for new students.

Field Name Description Validation Schema Example

haku required

Unique identifier for the admission "group", used to group admission targets

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

1.2.246.562.29.95390561488

hakuKausi required

Study term that the application is for, "K" (spring) or "S" (autumn). Maps to a part of the StudyRight.valid field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

S

hakukohde optional

Target university's ID of the study option. Used for finding the learning opportunity (and education) that the student applied to. Matched against values in the [LearningOpportunity].admissionTargetIds field

Size(max = 100, min = 1) [NewStudent]

[String]

1.2.246.562.20.19210018412

hakuVuosi required

Study year that the application is for. Maps to a part of the StudyRight.valid field

NotNull [NewStudent]

[Integer] int32

2018

ilmoittautumiset required

Study term registrations done via Opintopolku. Maps to TermRegistration objects. NOTE: registrations done via OILI are in the top-level 'ilmoittautumiset' field

NotNull [NewStudent]

List of OiliIlmoittautuminen

null

hKelpoisuusMaksuvelvollisuus required

Describes whether student is obligated to pay a yearly tuition fee.

NotNull [NewStudent]

[String]

REQUIRED

lukuvuosimaksu required

Describes whether student has paid the yearly tuition fee.

NotNull [NewStudent]

[String]

MAKSETTU

valintatapajononTyyppi optional

The student's admission type. Maps to the StudyRight.admissionTypeUrn field

[String]

Avoin väylä

OiliHenkilo

Personal and contact information about a student from OILI. Different values are available for new and continuing students.

Field Name Description Validation Schema Example

aidinkieli required

Mother tongue (ISO-639-1). Maps to the PrivatePerson.motherTongueUrn field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

fi

asiointikieli required

Preferred language. Possible values: "1" = Finnish, "2" = Swedish, "3" = English, "9" = other. Maps to the PrivatePerson.preferredLanguageUrn field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

1

etunimet required

First names. Maps to the PrivatePerson.firstNames field

NotNull [NewStudent]
Size(max = 100, min = 0) [NewStudent]

[String]

Antto Aapo

hetu required

Finnish personal identity code (HETU, e.g. "200681-9476") or 7-character birth date (date of birth part of HETU, e.g. "200600A"). Maps to the PrivatePerson.personalIdentityCode or PrivatePerson.dateOfBirth field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

200681-9476

kansalaisuudet required

Citizenships (ISO-3166-1 numeric values, also "999" = unknown). Maps to the PrivatePerson.citizenshipUrns field

NotEmpty [NewStudent]
ContainsNoNulls [NewStudent]

List of [string]

["246"]

kotikunta required

Municipality number of Population Register Centre. Maps to the PrivatePerson.municipalityUrn field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

049

koulusivistyskieli optional

School education language (ISO-639-1). Maps to the PrivatePerson.schoolEducationLanguageUrns field. Use either koulusivistyskieli v4 or koulusivistyskielet v5

Size(max = 100, min = 0)

[String]

FI

koulusivistyskielet optional

School education languages (ISO-639-1). Maps to the PrivatePerson.schoolEducationLanguageUrns field. Use either koulusivistyskieli v4 or koulusivistyskielet v5

ContainsNoNulls [NewStudent]

List of [string]

["FI"]

kutsumanimi required

Call name. Maps to the PrivatePerson.callName field

NotNull [NewStudent]
Size(max = 100, min = 0) [NewStudent]

[String]

Antto

lahiosoite required

Primary address. Maps to a part of the PrivatePerson.primaryAddress field

NotNull [NewStudent]
Size(max = 1024, min = 0) [NewStudent]

[String]

Anttotie 37

maa required

Primary address country (ISO-3166-1, also "999" = unknown). Maps to a part of the PrivatePerson.primaryAddress field

NotNull [NewStudent]
Size(max = 100, min = 1) [NewStudent]

[String]

246

matkapuhelin optional

Mobile phone number. Maps to the PrivatePerson.phoneNumber field

Size(max = 100, min = 0) [NewStudent]

[String]

+358 50 123 4567

opiskelijaAvain optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

Null [NewStudent]

[String]

otm-123456

oppijanumero required

Represents OpppijaID, assigned to all students, administered by Finnish National Board of Education.

NotNull [NewStudent]
ValidOppijaID [NewStudent]

[String]

1.2.246.562.24.55555966000

postinumero required

Primary address postal code. Maps to a part of the PrivatePerson.primaryAddress field

NotNull [NewStudent]
Size(max = 100, min = 0) [NewStudent]

[String]

02940

postitoimipaikka required

Primary address city. Maps to a part of the PrivatePerson.primaryAddress field

NotNull [NewStudent]
Size(max = 100, min = 0) [NewStudent]

[String]

Espoo

puhelin optional

Phone number. Maps to the PrivatePerson.phoneNumber field if the 'matkapuhelin' field has no value

Size(max = 100, min = 0) [NewStudent]

[String]

+358 9 123 4567

sahkoposti optional

Email address (RFC 2822). Maps to the PrivatePerson.secondaryEmail field, also to PrivatePerson.primaryEmail if not already set

Size(max = 100, min = 0) [NewStudent]

[String]

example@example.com

sukunimi required

Last name. Maps to the PrivatePerson.lastName field

NotNull [NewStudent]
Size(max = 100, min = 0) [NewStudent]

[String]

Heikkinen

sukupuoli optional

Gender (ISO 5218). Possible values: "0" = unknown, "1" = male, "2" = female, "9" = not applicable. Maps to the PrivatePerson.genderUrn field

Size(max = 100, min = 1) [NewStudent]

[String]

0

turvakielto required

Non-disclosure for personal safety reasons.

NotNull [NewStudent]

[Boolean]

false

OiliIlmoittautuminen

Information about a study term registration.

Field Name Description Validation Schema Example

kausi required

Study year and term, for example "2016K" (spring 2016) or "2015S" (autumn 2015). Maps to the TermRegistration.studyTerm field

NotNull
Size(max = 100, min = 1)

[String]

2016K

tila required

Registration state. Possible values: 1 = present, 2 = absent, 3 = statutorily absent, 4 = not registered. Maps to the TermRegistration.termRegistrationType field (and possibly to statutory absence related TermRegistration fields)

NotNull

[Integer] int32

1

OiliMaksutiedot

Student's payment information from OILI

Field Name Description Validation Schema Example

tilausnumero optional

Unique order number

[String]

XX.160119.18.40460

maksettuEur required

Total PAID sum of this order

NotNull

[BigDecimal]

5.0

tuotteet optional

List of products (payments)

List of OiliTuote

null

viitenumero optional

Reference number

[String]

null

OiliMeta

OILI document related meta information.

Field Name Description Validation Schema Example

aikaleima required

Document creation time. Maps to the StudyRight.grantDate field

NotNull

[Date] date-time

2018-01-18T15:31:52+02:00

ilmoittautumisaika required

Time when registration was received. Maps to the TermRegistration.registrationDate field

NotNull

[Date] date-time

2018-01-18T15:31:52+02:00

oiliId required

Registration ID in OILI

NotNull
Size(max = 100, min = 1)

[String]

XX.160119.18.40460

tyyppi required

Registration type (new/continuing); this affects what fields are available in the OILI document. Possible values: "1" = new student, "2" = continuing student

NotNull [ContinuingStudent]
Size(max = 100, min = 1)

[String]

1

OiliOpiskeluOikeus

Study right information; only available for continuing students.

Field Name Description Validation Schema Example

avain required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull [ContinuingStudent]

[String]

otm-123456

OiliPayment

A payment made by a student related to a specific study term and payment category. Should not be deleted but instead invalidated with a rationale.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

invalidated required

Is the payment invalidated

[Boolean]

null

invalidationRationale optional

Rationale for the invalidation of the payment, required if the payment is invalidated

Size(max = 8000, min = 0)

[String]

null

invalidatedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

invalidationDate optional

Date of which the payment was invalidated

[date] date

null

paymentAmount required

Amount of the payment in euros

NotNull
Min(value = 0)

[BigDecimal]

null

paymentDate optional

Date on which the payment was made

[date] date

null

registeredBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

source required

Source for payment creation, currently either PERSON or OILI

NotNull

[String] enum PERSON, OILI,

null

registrationDate required

Registration date for payment

NotNull

[date] date

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyYearStartYear required

Study year which this payment is registered

NotNull

[Integer] int32

null

studyTerm optional

StudyTermLocator

null

type required

Defines the type of payment made by a student.

NotNull

[String] enum OILI_PAYMENT, TUITION_FEE_PAYMENT,

null

paymentCategoryId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

orderNumber optional

Order number for this payment

[String]

null

OiliPaymentAllOf

Field Name Description Validation Schema Example

paymentCategoryId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

orderNumber optional

Order number for this payment

[String]

null

OiliTuote

A product related to a student's payment.

Field Name Description Validation Schema Example

tuotekoodi required

Product ID

NotNull

[String]

null

maksettuEur required

Paid amount

NotNull

[BigDecimal]

null

kausi optional

Study term that this payment is related to

[String]

null

tarkenne optional

Specifier for this prodct. 1 = Paid on OILI, 2 = Not paid on OILI

[String]

null

OrganisationRoleShareBase

Describes a given organisation is in a given role with a possible fractional share, if the role is shared

ValidOrganisationRoleShare

Field Name Description Validation Schema Example

organisationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

OrganisationId

[String]

otm-123456

educationalInstitutionUrn optional

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)

[String]

urn:code:educational-institution:*

roleUrn required

Represents Uniform Resource Names for roles of organisations in learning opportunities. Supported values available here

NotNull
UrnCode(namespace = urn:code:organisation-role, onlySyntax = false)

[String]

urn:code:organisation-role:*

share required

The share, greater than zero and at most one. The shares of one role must sum to one.

NotNull
DecimalMin(inclusive = true, value = 0)
DecimalMax(inclusive = true, value = 1)

[BigDecimal]

null

OrganisationRoleShareBasePublic

Describes a given organisation is in a given role with a possible fractional share, if the role is shared

Field Name Description Validation Schema Example

organisationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationalInstitutionUrn optional

Represents Uniform Resource Names for educational institutions. Supported values available here

[String]

urn:code:educational-institution:*

roleUrn required

Represents Uniform Resource Names for roles of organisations in learning opportunities. Supported values available here

[String]

urn:code:organisation-role:*

share required

The share, greater than zero and at most one. The shares of one role must sum to one.

[BigDecimal]

null

Passport

Passport for person.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

passportNumber required

Passport number

[String]

null

issuer required

Passport issuing country, ISO-3166-1

[String]

null

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

PatchEntity

A single patched entity must include the 'id' parameter to identify which entity to apply the patch to, and any other fields to be changed.

Field Name Description Validation Schema Example

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PersonDataChange

Change history object for personal identity information.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

modifiedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

modifiedByName optional

Name of the person who made this modification.

[String]

null

modified optional

Modification time stamp

[Date] date-time

null

validUntil optional

Date when this information ceased to be valid. Usually the official date when personal identification, eg. name change, became valid.

[date] date

null

oldPersonalIdentityCode optional

Old personal identity code

[String]

null

oldFirstNames optional

Previous first names

[String]

null

oldLastName optional

Previous last/family name

[String]

null

correction optional

If true, this was incorrect information (misregistration); if false, this was at a time correct information.

[Boolean]

null

PersonGroup

Abstract supertype of person groups

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

LocalizedString

null

description optional

LocalizedString

null

updateType required

Manual groups must be updated by an administrator manually, while automatic groups are updated by running a student search periodically.

NotNull

[String] enum MANUAL, AUTOMATIC,

null

membershipUpdateTime optional

The time when memberships of this group was updated. Used only when updateType is AUTOMATIC.

[Date] date-time

null

membershipCheckTime optional

The time when memberships of this group was checked. Used only when updateType is AUTOMATIC.

[Date] date-time

null

responsibilityInfos required

Persons or roles in a responsibility relation to this group

NotNull [Active]
Size(max = 200, min = 0)
ContainsNoNulls

Set of PersonWithGroupResponsibilityInfoType

null

personQueries optional

List of conditions (joined by OR) for checking persons possible membership in this group. Unnecessary for MANUAL updateType.

ContainsNoNulls
Size(max = 20, min = 0)

List of PersonQuery

null

validMemberships optional

Number of valid memberships in group (read-only, only for group search)

[Integer] int32

null

type required

Group type

[String]

null

PersonGroupMembership

Membership to person group

Field Name Description Validation Schema Example

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personGroupName optional

LocalizedString

null

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personFirstNames optional

First names of the person in this membership (only when reading)

[String]

null

personLastName optional

Last name of the person in this membership (only when reading)

[String]

null

personStudentNumber optional

Student number of the person in this membership (only when reading)

[String]

null

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

personPrimaryEmail optional

Primary email of the person in this membership (only when reading)

[String]

null

PersonQuery

A collection of person query parameters.

Field Name Description Validation Schema Example

searchString optional

Search by names, email or student number

Size(max = 1024, min = 0)

[String]

null

genderUrns optional

Search by gender

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

motherTongueUrns optional

Search by native language

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

schoolEducationLanguageUrns optional

Search by school education language

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

preferredLanguageUrns optional

Search by preferred language

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

municipalityUrns optional

Search by municipality

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

citizenshipUrns optional

Search by citizenship

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightOrganisationIds optional

Search by study right organisation id

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightParentOrganisationIds optional

Search by study right parent organisation id

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightEducationIds optional

Search by study right education id

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightLearningOpportunities optional

Search by study right learning opportunity

Size(max = 200, min = 0)
ContainsNoNulls

List of StudyRightLearningOpportunity

null

studyRightExpirationRulesUrns optional

Search by study right expiration rules

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightStates optional

Search by study right state

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

enum

null

studyStartDateRanges optional

Search by study start date

Size(max = 200, min = 0)
ContainsNoNulls

List of LocalDateRange

null

attendingTermRegistrations optional

Search by attending term registrations

Size(max = 200, min = 0)
ContainsNoNulls

List of StudyTermLocator

null

nonAttendingTermRegistrations optional

Search by nonattending term registrations

Size(max = 200, min = 0)
ContainsNoNulls

List of StudyTermLocator

null

studyRightSelectedOptions optional

Search by selected option

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightSelectedChildOptions optional

Search by selected child option

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightMinorSelections optional

Search by minor selections

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

studyRightModuleSelections optional

Search by modules selected in the study right (applicable only to non-degree study rights)

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

dead optional

Search deceased or not deceased, not deceased by default

[Boolean]

null

dateOfBirth optional

Search by date of birth

[date] date

null

studyRightTuitionFeeObligationPeriodRanges optional

Search by tuition fee obligation dates

Size(max = 200, min = 0)
ContainsNoNulls

List of LocalDateRange

null

activePhaseModuleGroupIds optional

Search by module group id of active phase of study right

Size(max = 200, min = 0)
ContainsNoNulls

List of [string]

null

personIds optional

Search inside the predefined personIds

Size(max = 4000, min = 0)
ContainsNoNulls

List of [string]

null

PersonWithAttainmentAcceptorType

Describes a given person or textual personified role that has a given responsibility

SomeFieldsNotNull(fields = [Ljava.lang.String;@31f8b222, maxNull = 1, minNull = 0)

Field Name Description Validation Schema Example

text optional

LocalizedString

null

personId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

roleUrn required

Role of person accepting attainments

NotNull

[String] enum urn:code:attainment-acceptor-type:approved-by, urn:code:attainment-acceptor-type:coordinating-supervisor, urn:code:attainment-acceptor-type:coordinating-professor, urn:code:attainment-acceptor-type:supervising-professor, urn:code:attainment-acceptor-type:more-supervising-professor, urn:code:attainment-acceptor-type:examinator, urn:code:attainment-acceptor-type:supervisor, urn:code:attainment-acceptor-type:thesis-advisor, urn:code:attainment-acceptor-type:examiner, urn:code:attainment-acceptor-type:preliminary-examiner, urn:code:attainment-acceptor-type:opponent, urn:code:attainment-acceptor-type:custos,

null

title optional

LocalizedString

null

PersonWithAttainmentAcceptorTypePublic

Describes a given person or textual personified role that has a given responsibility

Field Name Description Validation Schema Example

text optional

LocalizedString

null

personId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

roleUrn required

Role of person accepting attainments

[String] enum urn:code:attainment-acceptor-type:approved-by, urn:code:attainment-acceptor-type:coordinating-supervisor, urn:code:attainment-acceptor-type:coordinating-professor, urn:code:attainment-acceptor-type:supervising-professor, urn:code:attainment-acceptor-type:more-supervising-professor, urn:code:attainment-acceptor-type:examinator, urn:code:attainment-acceptor-type:supervisor, urn:code:attainment-acceptor-type:thesis-advisor, urn:code:attainment-acceptor-type:examiner, urn:code:attainment-acceptor-type:preliminary-examiner, urn:code:attainment-acceptor-type:opponent, urn:code:attainment-acceptor-type:custos,

null

title optional

LocalizedString

null

PersonWithGroupResponsibilityInfoType

Describes a given person or textual personified role that has a given responsibility

SomeFieldsNotNull(fields = [Ljava.lang.String;@940d9a6, maxNull = 1, minNull = 0)

Field Name Description Validation Schema Example

text optional

LocalizedString

null

personId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

roleUrn required

Person role related to groups

NotNull

[String] enum urn:code:group-responsibility-info-type:responsible-tutor, urn:code:group-responsibility-info-type:tutor, urn:code:group-responsibility-info-type:administrative-person,

null

validity optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

personFirstNames optional

First names of the person (read-only, only for group search)

[String]

null

personLastName optional

Last name of the person (read-only, only for group search)

[String]

null

personEmployeeNumber optional

Employee number of the person (read-only, only for group search)

[String]

null

validityPeriod optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

PersonalizedPhase

Phase in PersonalizedSelectionPath representing a personalized phase in student's study right.

ValidPersonalizedPhase

Field Name Description Validation Schema Example

rationale required

Rationale for this personalized phase

NotNull
Size(max = 8000, min = 0)

[String]

null

createdBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

createdOn required

When was the personalized phase created

NotNull

[Date] date-time

null

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
ModuleGroupId

[String]

otm-123456

childModuleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

ModuleGroupId

[String]

otm-123456

childNamingUrn required

Supported values available here

UrnCode(namespace = urn:code:education-option-naming-type, onlySyntax = false)

[String]

urn:code:education-option-naming-type:*

degreeTitleUrn required

Supported values available here

UrnCode(namespace = urn:code:degree-title, onlySyntax = false)

[String]

urn:code:degree-title:*

educationClassificationUrn optional

Supported values available here

UrnCode(namespace = urn:code:education-classification, onlySyntax = false)

[String]

urn:code:education-classification:*

PersonalizedSelectionPath

Personalized selection path for student (HEKO). Can include personalized selection paths or bridge studies.

ValidPersonalizedSelectionPath

Field Name Description Validation Schema Example

phase1 optional

ValidPersonalizedPhase

PersonalizedPhase

null

phase2 optional

ValidPersonalizedPhase

PersonalizedPhase

null

Plan

Study plan of a student. It may be valid or invalid according to the plan validation rules contained in the module selections.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

rootId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
EducationId

[String]

otm-123456

learningOpportunityId optional

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

userId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

[String]

null

curriculumPeriodId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
CurriculumPeriodId

[String]

otm-123456

moduleSelections required

Modules selected into the plan.

NotEmpty
Size(max = 200, min = 0)
ContainsNoNulls

Set of ModuleSelection

null

courseUnitSelections required

Course units selected into the plan.

NotNull
Size(max = 200, min = 0)
ContainsNoNulls

Set of CourseUnitSelection

null

customModuleAttainmentSelections required

Custom module attainments selected into the plan.

NotNull
Size(max = 200, min = 0)
ContainsNoNulls

Set of CustomModuleAttainmentSelection

null

customCourseUnitAttainmentSelections required

Custom course units selected into the plan.

NotNull
Size(max = 200, min = 0)
ContainsNoNulls

Set of CustomCourseUnitAttainmentSelection

null

assessmentItemSelections required

Assessment items selected into the plan.

NotNull
Size(max = 200, min = 0)
ContainsNoNulls

Set of AssessmentItemSelection

null

timelineNotes required

Timeline notes made by student.

NotNull
Size(max = 200, min = 0)
ContainsNoNulls

List of TimelineNote

null

customStudyDrafts required

Custom study drafts made by the student.

NotNull
ContainsNoNulls
Size(max = 200, min = 0)

Set of CustomStudyDraft

null

primary optional

Defines whether this plan is primary plan for this education. Only one plan can be primary at any given time for an education

[Boolean]

null

PriorCompetence

Informal prior learning, e.g. adult education or training organized by an employer

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

type required

Type of prior learning.

NotNull

[String] enum COMPETENCE, STUDIES,

null

name required

Name of this prior learning.

Size(max = 100, min = 1)
NotNull

[String]

null

organisation required

Organization where this prior learning was gained.

Size(max = 1024, min = 1)
NotNull

[String]

null

description required

Description of prior learning.

Size(max = 8000, min = 1)
NotNull

[String]

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

UrnCode(namespace = urn:code:language, onlySyntax = false)

[String]

urn:code:language:*

attainmentPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

PriorCompetenceAllOf

Field Name Description Validation Schema Example

attainmentPeriod optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

PriorLearning

Detailed description of prior learning. Can represent either prior university studies (e.g. course units), or informal prior competence (e.g. skills acquired through work or other institutions)

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

type required

Type of prior learning.

NotNull

[String] enum COMPETENCE, STUDIES,

null

name required

Name of this prior learning.

Size(max = 100, min = 1)
NotNull

[String]

null

organisation required

Organization where this prior learning was gained.

Size(max = 1024, min = 1)
NotNull

[String]

null

description required

Description of prior learning.

Size(max = 8000, min = 1)
NotNull

[String]

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

UrnCode(namespace = urn:code:language, onlySyntax = false)

[String]

urn:code:language:*

PriorLearningInclusionWorkflow

Workflow for including prior learnings in current studies.

ValidModuleReference

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

priorLearnings optional

List of all prior learnings that should be considered within this workflow.

List of PriorLearning

null

name required

Descriptive name of the workflow

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

customStudyDraft optional

CustomStudyDraft

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningInclusionWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

priorLearnings optional

List of all prior learnings that should be considered within this workflow.

List of PriorLearning

null

name optional

Descriptive name of the workflow

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

customStudyDraft optional

CustomStudyDraft

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningInclusionWorkflowApplication

Application related to PriorLearningInclusionWorkflow.

ValidModuleReference

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

name required

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

customStudyDraft optional

CustomStudyDraft

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningInclusionWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

name optional

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

customStudyDraft optional

CustomStudyDraft

null

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningSubstitutionWorkflow

Workflow for substituting a course unit with prior learnings.

ValidPriorLearningSubstitutionWorkflow

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

priorLearnings optional

List of all prior learnings that should be considered within this workflow.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningSubstitutionWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

priorLearnings optional

List of all prior learnings that should be considered within this workflow.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningSubstitutionWorkflowApplication

Application related to PriorLearningSubstitutionWorkflow.

ValidCourseUnitReference

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorLearningSubstitutionWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

PriorStudies

Formal prior learning, e.g. earlier university studies

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

type required

Type of prior learning.

NotNull

[String] enum COMPETENCE, STUDIES,

null

name required

Name of this prior learning.

Size(max = 100, min = 1)
NotNull

[String]

null

organisation required

Organization where this prior learning was gained.

Size(max = 1024, min = 1)
NotNull

[String]

null

description required

Description of prior learning.

Size(max = 8000, min = 1)
NotNull

[String]

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

UrnCode(namespace = urn:code:language, onlySyntax = false)

[String]

urn:code:language:*

code optional

Code defining this prior learning (e.g. code of a course unit)

[String]

null

attainmentDate required

Date when the study was completed.

[date] date

null

grade required

Grade gained from the study

[String]

null

gradeScale required

Grade scale used to grade the study

[String]

null

credits required

Gained credits, can be a textual representation

[String]

null

PriorStudiesAllOf

Field Name Description Validation Schema Example

code optional

Code defining this prior learning (e.g. code of a course unit)

[String]

null

attainmentDate optional

Date when the study was completed.

[date] date

null

grade optional

Grade gained from the study

[String]

null

gradeScale optional

Grade scale used to grade the study

[String]

null

credits optional

Gained credits, can be a textual representation

[String]

null

PrivatePerson

PrivatePerson may be a student, or a member of teaching or administrative staff.

ValidLegacyPrivatePerson [Legacy]

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studentNumber optional

Student number, if the person is a student

Size(max = 100, min = 1)
ValidSanitized

[String]

null

personalIdentityCode optional

Finnish personal identity code (HETU). Required if citizenshipUrns contains Finnish or Ålander and studentStatus is ACTIVE

ValidPersonalIdentificationCode

[String]

null

finnAuthId optional

FinnAuthId hash is validated by the same rules as Finnish PIC.

ValidFinnAuthId

[String]

1234567892

eidasId optional

EidasID is an identification code for identifying students related to immigration processes

Size(max = 256, min = 1)

[String]

null

dateOfBirth optional

Date of birth for non-Finnish persons. Required if citizenshipUrns does not contain Finnish or Ålander and studentStatus is ACTIVE

[date] date

null

userName optional

User name of the student

Size(max = 100, min = 1)

[String]

null

eduPersonPrincipalName optional

Used to match the student authentication from IDP

Size(max = 100, min = 1)

[String]

null

employeeNumber optional

Employee number, must be locally unique within the organisation. If set, user can access staff and teacher UIs. Can be used to search employees.

Size(max = 100, min = 1)

[String]

null

phoneNumber optional

Phone number for the user

Size(max = 100, min = 1)

[String]

null

primaryAddress optional

FinnishAddress

null

secondaryAddress optional

[PrivatePerson_secondaryAddress]

null

genderUrn required

Represents Uniform Resource Names for genders. Supported values available here

UrnCode(namespace = urn:code:gender, onlySyntax = false)
NotNull

[String]

urn:code:gender:*

citizenshipUrns optional

Citizenships of the person, as a references to code book country. Required only for Student

Size(max = 20, min = 0)
UrnCode(namespace = urn:code:country, onlySyntax = false)
ContainsNoNulls

Set of [string]

null

motherTongueUrn optional

Represents Uniform Resource Names for languages. Supported values available here

UrnCode(namespace = urn:code:language, onlySyntax = false)

[String]

urn:code:language:*

preferredLanguageUrn optional

Represents Uniform Resource Names for preferred language used in communication. Supported values available here

UrnCode(namespace = urn:code:preferred-language, onlySyntax = false)

[String]

urn:code:preferred-language:*

schoolEducationLanguageUrns optional

The languages the person got their School Education in Finland, as a reference to code book school education language.

UrnCode(namespace = urn:code:school-education-language, onlySyntax = false)

Set of [string]

null

municipalityUrn optional

Represents Uniform Resource Names for municipalities of Finland. Supported values available here

UrnCode(namespace = urn:code:municipality, onlySyntax = false)

[String]

urn:code:municipality:*

oppijanumero optional

Full Opintopolku.fi Oppijanumero (OID) that uniquely identifies the person, as given by Finnish Board of Education

[String]

null

oids optional

All OIDs that uniquely identify the person, including ONR duplicate person OIDs and preferably also oppijanumero

Set of [string]

null

dead required

This is true if the person has died

NotNull [Active]

[Boolean]

null

classifiedPersonInfo optional

ClassifiedPersonInfo

null

personalDataSafetyNonDisclosure optional

This is true if the person has personal safety non-disclosure

[Boolean]

null

studentStatus required

Contains ACTIVE/NONE -values. Determines if person is student or not.

NotNull [Active]

[String] enum ACTIVE, NONE,

null

employeeStatus required

Contains ACTIVE/NONE/INACTIVE -values. INACTIVE = Previously been part of the staff. NONE = hasn't been employee. ACTIVE = currentlybeing employee. Determines if person is employee or not.

NotNull [Active]

[String] enum ACTIVE, NONE, INACTIVE,

null

identityConfirmed required

Is the person's identity confirmed by a strong authentication method. Defaults to true, unauthenticated persons are created only in special cases

NotNull [Active]

[Boolean]

null

oppijaID optional

(deprecated) Opintopolku.fi Oppija OID that uniquely identifies the person, as given by Finnish Board of Education. Expected to be oppijanumero

[String]

null

firstNames optional

First names of the student

Size(max = 100, min = 1)

[String]

null

callName optional

Call name of the student

Size(max = 100, min = 1)

[String]

null

lastName optional

Last name of the student

Size(max = 100, min = 1)

[String]

null

primaryEmail optional

Primary email address of the person, typically set by the university. This may be used in people searches.

Size(max = 100, min = 1)

[String]

null

secondaryEmail optional

Secondary email address of the person

Size(max = 100, min = 1)

[String]

null

PrivatePersonPatchEntity

A single patched entity must include at least one of the following parameters ['id', 'eduPersonPrincipalName', 'personalIdentityCode', 'employeeNumber', 'studentNumber', 'oppijanumero', 'oids'] to identify which entity to apply the patch to, and any other fields to be changed.

Field Name Description Validation Schema Example

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

personalIdentityCode optional

PersonaIdentityCode for the entity to apply the patch to

[String]

null

eduPersonPrincipalName optional

EduPersonPrincipalName for the entity to apply the patch to

[String]

null

employeeNumber optional

Employee number for the entity to apply the patch to

[String]

null

studentNumber optional

Student number for the entity to apply the patch to

[String]

null

oppijanumero optional

Oppijanumero for the entity to apply the patch to

[String]

null

oids optional

Oids for the entity to apply the patch to

Set of [string]

null

PrivatePersonSecondaryAddress

Field Name Description Validation Schema Example

countryUrn required

Represents Uniform Resource Names for country names. Supported values available here

UrnCode(namespace = urn:code:country, onlySyntax = false)
NotNull

[String]

urn:code:country:*

isUserEditable optional

Set to false to prevent address from being edited in the user interface.

[Boolean]

null

type required

Address type, either GenericAddress or FinnishAttainment

[String]

null

streetAddress optional

Street address part of the address

[String]

null

postalCode optional

Postal code of the address

[String]

null

city optional

City of the address

[String]

null

address optional

The whole address excluding the country

[String]

null

Proposal

Proposal for accepting or rejecting a study right extension application.

ValidProposal

Field Name Description Validation Schema Example

result required

Result of the proposal

NotNull

[String] enum APPROVE, REJECT,

null

presenterId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PublicPersonId

[String]

otm-123456

presenterTitle optional

LocalizedString

null

rationale optional

The rationale behind the proposal

Size(max = 8000, min = 1)

[String]

null

RecentAttainmentsFrontpageComponentSetting

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

Recommendation

Content recommendation regarding the decision for this workflow.

Field Name Description Validation Schema Example

state required

The state of this recommendation

[String] enum NOT_HANDLED, RECOMMENDED, NOT_RECOMMENDED,

null

responsiblePerson optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsiblePersonTitle optional

LocalizedString

null

additionalInformation optional

Additional information about the person giving this recommendation. Deprecated, read only.

[String]

null

comment optional

Rationale for this recommendation

[String]

null

RequiredModuleContentWorkflow

Workflow for granting required approval for module content.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

RequiredModuleContentWorkflowApplication

Application related to RequiredModuleContentWorkflow.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationRationale optional

Students rationale for this approval request

[String]

null

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

Signatory

Person signing a document

Field Name Description Validation Schema Example

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PublicPersonId

[String]

otm-123456

title required

LocalizedString

null

StudentPayment

A payment made by a student to either the university or the student union. See subclasses for concrete payment types.

FieldsNotNullWhenConditionTrue(condition = type == T(fi.helsinki.otm.common.model.payment.StudentPaymentType).TUITION_FEE_PAYMENT, fields = [Ljava.lang.String;@69987b5d)

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

invalidated required

Is the payment invalidated

[Boolean]

null

invalidationRationale optional

Rationale for the invalidation of the payment, required if the payment is invalidated

Size(max = 8000, min = 0)

[String]

null

invalidatedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

invalidationDate optional

Date of which the payment was invalidated

[date] date

null

paymentAmount required

Amount of the payment in euros

NotNull
Min(value = 0)

[BigDecimal]

null

paymentDate optional

Date on which the payment was made

[date] date

null

registeredBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

source required

Source for payment creation, currently either PERSON or OILI

NotNull

[String] enum PERSON, OILI,

null

registrationDate required

Registration date for payment

NotNull

[date] date

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyYearStartYear required

Study year which this payment is registered

NotNull

[Integer] int32

null

studyTerm optional

StudyTermLocator

null

type required

Defines the type of payment made by a student.

NotNull

[String] enum OILI_PAYMENT, TUITION_FEE_PAYMENT,

null

StudentWorkflow

A workflow that is related to a specific student.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudentWorkflowAllOf

Field Name Description Validation Schema Example

studentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType optional

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyProgressFrontpageComponentSetting

Contains study progress graph specific settings for a user

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyProgressFrontpageComponentSettingAllOf

Field Name Description Validation Schema Example

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyRight

One of possibly many study rights a student can have. This refers to a major study right, i.e. a degree study right or some other primary mechanism.

ValidCooperationNetworkStatusAndRights

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

snapshotDateTime required

Start of validity for the snapshot. End of validity is defined by the snapshotDateTime of a possible later snapshot.

[Date] date-time

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull [Active]
EducationId

[String]

otm-123456

organisationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull [Active]
OrganisationId

[String]

otm-123456

learningOpportunityId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull [Active]

[String]

otm-123456

admissionTargetId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

AdmissionTargetId

[String]

otm-123456

admissionIdentifier optional

Unique admission identifier that has been linked to this study right when imported from OILI. This is used to group multiple admission targets.

[String]

null

decreeOnUniversityDegreesUrn optional

Possible values for the version of the decree on university degrees (tutkintoasetus) that a study right follows. Supported values available here

UrnCode(namespace = urn:code:decree-on-university-degrees, onlySyntax = false)

[String]

urn:code:decree-on-university-degrees:*

studyRightExpirationRulesUrn required

Possible values for expiration rule (rajauslaki) of a study right. Supported values available here

NotNull [Active]
UrnCode(namespace = urn:code:study-right-expiration-rules, onlySyntax = false)

[String]

urn:code:study-right-expiration-rules:*

degreeRegulations optional

The degree regulations ("tutkintosääntö") that apply to this study right.

[String]

null

valid required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

grantDate required

Date when this study right was granted. Can be earlier than validity period start.

NotNull [Active]

[date] date

null

studyStartDate optional

Date when the student was first registered as present. May be null, if this has not happened yet.

[date] date

null

transferOutDate optional

When this right was transferred out of our university. If set, valid.end is set to the following day. Null if no transfer out. Used together with transferOutUniversityUrn.

[date] date

null

transferOutUniversityUrn optional

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)

[String]

urn:code:educational-institution:*

homeOrganisationUrn optional

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)

[String]

urn:code:educational-institution:*

termRegistrations optional

List of information objects about registrations, only returned for internal APIs, not import/export interfaces. Term registrations are separate from study right but included for internal APIs only. Term registrations are not temporal and do not include snapshot data. They can be empty, at the beginning of the lifetime of the study right, when no registrations have been made and no registration deadlines have passed.

ContainsNoNulls
Size(max = 400, min = 0)

List of TermRegistration

null

studyRightExtensions optional

List of extensions that have been granted to this study right. Some of the extensions might be revoked, meaning that they don't affect the duration of the study right.

ContainsNoNulls

List of StudyRightExtension

null

studyRightCancellation optional

ValidStudyRightCancellation

StudyRightCancellation

null

studyRightGraduation optional

StudyRightGraduation

null

acceptedSelectionPath required

LearningOpportunitySelectionPath

null

requestedSelectionPath required

LearningOpportunitySelectionPath

null

studyRightTransfer optional

StudyRightTransfer

null

phase1MinorSelections optional

The minor selections belonging to phase1 of this study right. May include unapproved selections.

ContainsNoNulls
Size(max = 20, min = 0)

Set of StudyRightMinorSelection

null

phase2MinorSelections optional

The minor selections belonging to phase2 of this study right. May include unapproved selections.

ContainsNoNulls
Size(max = 20, min = 0)

Set of StudyRightMinorSelection

null

state optional

NOT_STARTED means that study right starts in the future, and is not yet valid or active. ACTIVE means that the study right is active. ACTIVE_NONATTENDING means that study right is active but student is not attending to current term.RESCINDED means that the student has rescinded their study right. Study right can become PASSIVE for example when the student union dues have not been paid. Also, when student chooses one optional study right, it becomes active, and others become PASSIVE. Non-degree Study right can be EXPIRED, if it is no longer valid by validity date range.CANCELLED_BY_ADMINISTRATION means the study right is cancelled by administration, reason should be stated in cancellation object. GRADUATED means that there is an attainment for the education/study moduleTENTATIVE means that study right is for a cross study student and it is activated when student has successfully enrolled and accepted to a cur

Study right is automatically ended after valid.endDate is reached. There is no specific state for that.

[String] enum NOT_STARTED, ACTIVE, ACTIVE_NONATTENDING, GRADUATED, RESCINDED, CANCELLED_BY_ADMINISTRATION, TENTATIVE, DENIED, PASSIVE, EXPIRED,

null

statePeriods optional

List of study right states for each time period. This is a readonly property, updated automatically based on term registrations and study right data

List of StudyRightStatePeriod

null

personalizedSelectionPath optional

ValidPersonalizedSelectionPath

PersonalizedSelectionPath

null

courseUnitSelections optional

Course unit selections of the study right. eg. participation rights purchased from open university

ContainsNoNulls

Set of StudyRightCourseUnitSelection

null

moduleSelections optional

Module selections of the study right.

ContainsNoNulls

Set of StudyRightModuleSelection

null

studyFieldUrn optional

Supported values available here

UrnCode(namespace = urn:code:study-field, onlySyntax = false)

[String]

urn:code:study-field:*

phase1EducationClassificationUrn optional

Supported values available here

UrnCode(namespace = urn:code:education-classification, onlySyntax = false)

[String]

urn:code:education-classification:*

phase2EducationClassificationUrn optional

Supported values available here

UrnCode(namespace = urn:code:education-classification, onlySyntax = false)

[String]

urn:code:education-classification:*

phase1EducationClassificationLocked required

`true` if education classification for phase 1 is locked. If `true`, SISU won't change the code automatically. Defaults to `false`

NotNull

[Boolean]

null

phase2EducationClassificationLocked required

`true` if education classification for phase 2 is locked. If `true`, SISU won't change the code automatically. Defaults to `false`

NotNull

[Boolean]

null

fundingSourceUrn optional

Universal Resource Name for source of funding (Virta). Supported values available here

UrnCode(namespace = urn:code:funding-source, onlySyntax = false)

[String]

urn:code:funding-source:*

phase1QualificationUrns optional

Qualifications for phase 1 of study right

UrnCode(namespace = urn:code:qualification, onlySyntax = false)

Set of [string]

null

phase2QualificationUrns optional

Qualifications for phase 2 of study right

UrnCode(namespace = urn:code:qualification, onlySyntax = false)

Set of [string]

null

phase1EducationLocationUrn required

Represents Uniform Resource Names for municipalities of Finland. Supported values available here

UrnCode(namespace = urn:code:municipality, onlySyntax = false)
NotNull [Active]

[String]

urn:code:municipality:*

phase2EducationLocationUrn optional

Represents Uniform Resource Names for municipalities of Finland. Supported values available here

UrnCode(namespace = urn:code:municipality, onlySyntax = false)

[String]

urn:code:municipality:*

phase1InternationalContractualDegree optional

ValidInternationalContractualDegree

InternationalContractualDegree

null

phase2InternationalContractualDegree optional

ValidInternationalContractualDegree

InternationalContractualDegree

null

admissionTypeUrn optional

Universal resource name for Admission type. Supported values available here

UrnCode(namespace = urn:code:admission-type, onlySyntax = false)

[String]

urn:code:admission-type:*

codeUrns required

Values for university-specific custom code books

Size(max = 200, min = 0)
NotNull
UrnCode(namespace = , onlySyntax = false)

Set of [string]

null

additionalInformation optional

LocalizedString

null

basedOnEnrolmentRights required

`true` if the study right is based on enrolment rights. Defaults to `false`

NotNull

[Boolean]

null

cooperationNetworkRights optional

Cooperation networks that study right is entitled to

NonOverlappingCooperationNetworkRights

Set of CooperationNetworkRight

null

cooperationNetworkStatus optional

StudyRightCooperationNetworkStatus

null

schoolEducationLanguageUrn optional

Represents Uniform Resource Names for languages of school education in Finland. Supported values here

UrnCode(namespace = urn:code:school-education-language, onlySyntax = false)

[String]

urn:code:school-education-language:*

StudyRightCancellation

Properties related to cancellation of study right

ValidStudyRightCancellation

Field Name Description Validation Schema Example

cancellationDate required

Date on which study right was cancelled

NotNull

[date] date

null

cancellationReason required

Comments by staff related to reason for cancellation

NotNull
Size(max = 255, min = 1)

[String]

null

cancellationType required

NOT_STARTED means that study right starts in the future, and is not yet valid or active. ACTIVE means that the study right is active. ACTIVE_NONATTENDING means that study right is active but student is not attending to current term.RESCINDED means that the student has rescinded their study right. Study right can become PASSIVE for example when the student union dues have not been paid. Also, when student chooses one optional study right, it becomes active, and others become PASSIVE. Non-degree Study right can be EXPIRED, if it is no longer valid by validity date range.CANCELLED_BY_ADMINISTRATION means the study right is cancelled by administration, reason should be stated in cancellation object. GRADUATED means that there is an attainment for the education/study moduleTENTATIVE means that study right is for a cross study student and it is activated when student has successfully enrolled and accepted to a cur

Study right is automatically ended after valid.endDate is reached. There is no specific state for that.

NotNull

[String] enum NOT_STARTED, ACTIVE, ACTIVE_NONATTENDING, GRADUATED, RESCINDED, CANCELLED_BY_ADMINISTRATION, TENTATIVE, DENIED, PASSIVE, EXPIRED,

null

StudyRightCooperationNetworkStatus

Co-operation network status for study rights that are created or targeted through RIPA to a cooperation network university

Field Name Description Validation Schema Example

direction required

Cooperation network direction seen from SISU

NotNull

[String] enum INBOUND, OUTBOUND, NONE,

null

organisationTkCode optional

Organisation TK code used in CSC's Ristiinopiskelupalvelu. For OUTBOUND entities, organisationTkCode represents the organisation where this entity is going to be sent. For INBOUND entities, organisationTkCode represents the organisation this entity originated from.

[String]

null

outboundStatus optional

Co-operation network status for entities that are sent through RIPA to a cooperation network host university

[String] enum NOT_VALID, FORWARDED, RECORDED, REJECTED,

null

rejectionReason optional

LocalizedString

null

outboundStatusMessage optional

Status message further describing processing of OUTBOUND entity to other university

[String]

null

cooperationNetworkId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

universityOrgId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

homeStudyRightId optional

[String]

null

inboundStatus optional

Co-operation network status for entities that are received through RIPA

[String] enum ACCEPTED, PROCESSING, REJECTED,

null

homeStudyRightValidity optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

StudyRightCourseUnitSelection

Course unit selection of study right

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

validityPeriod optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

acceptorPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

acceptanceDate optional

The date that the selection was approved.

[date] date

null

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

CourseUnitGroupId
NotNull

[String]

otm-123456

StudyRightExtension

Properties related to the extension of a study right. An extension is always counted in full semesters, and the actual start and end date of the extension are determined by the validity period of the corresponding study semester(s).

ValidStudyRightExtension

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

state required

State of a study right extension

NotNull

[String] enum ACTIVE, DELETED,

null

extensionCount optional

How many additional semesters does this extension grant to the study right

Min(value = 1)
Max(value = 4)

[Integer] int32

null

extensionStartDate required

The date when this extension starts

NotNull

[date] date

null

grantDate required

The date when this extension was granted

NotNull

[date] date

null

workflowId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

WorkflowId

[String]

otm-123456

grantReason optional

The reason why this extension was granted (alternative to applicationId)

Size(max = 255, min = 1)

[String]

null

grantedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

deleteDate optional

The date when this extension was deleted

[date] date

null

deleteReason optional

The reason why this extension was deleted

Size(max = 255, min = 1)

[String]

null

deletedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

applicationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyRightExtensionWorkflow

Workflow for granting extension to StudyRight.

ValidStudyRightExtensionWorkflow

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

initiatorType required

Indicates whether the workflow has been initiated by the student or a staff member.

[String] enum STUDENT, STAFF,

null

cancellingDisabled optional

Indicates, whether the student is allowed to cancel or revoke the application (workflow).

[Boolean]

null

personFirstNames optional

First names of the student (only for searches)

[String]

null

personLastName optional

Last name of the student (only for searches)

[String]

null

personStudentNumber optional

Student number of the student (only for searches)

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the workflow to be printed and mailed to a physical address

[Boolean]

null

cancellerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

cancelReason optional

Reason why workflow was cancelled

[String]

null

cancelTime optional

Cancellation time of workflow

[Date] date-time

null

cancelledByType optional

Indicates, whether the workflow was cancelled or revoked by STAFF or STUDENT

[String] enum STUDENT, STAFF,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot required

Plan

null

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightValidity required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this workflow was created

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the workflow was created

List of TermRegistration

null

usedAttendanceTerms required

The amount of used attendance terms at the time the workflow was created

[Integer] int32

null

usedAbsenceTerms required

The amount of used absence terms at the time the workflow was created

[Integer] int32

null

usedStatutoryAbsenceTerms required

The amount of used statutory absence terms at the time the workflow was created

[Integer] int32

null

termsWithoutRegistration required

The amount of study terms without a term registration at the time the workflow was created

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the workflow was created

Set of [string]

null

phase1Progress required

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms to be granted

[Integer] int32

null

delayRationale optional

Additional info related to why the studies have been delayed

[String]

null

applicationRationale optional

Additional info related to how the student plans to finish his/her studies

[String]

null

StudyRightExtensionWorkflowAllOf

Field Name Description Validation Schema Example

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot optional

Plan

null

educationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightValidity optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this workflow was created

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the workflow was created

List of TermRegistration

null

usedAttendanceTerms optional

The amount of used attendance terms at the time the workflow was created

[Integer] int32

null

usedAbsenceTerms optional

The amount of used absence terms at the time the workflow was created

[Integer] int32

null

usedStatutoryAbsenceTerms optional

The amount of used statutory absence terms at the time the workflow was created

[Integer] int32

null

termsWithoutRegistration optional

The amount of study terms without a term registration at the time the workflow was created

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the workflow was created

Set of [string]

null

phase1Progress optional

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms to be granted

[Integer] int32

null

delayRationale optional

Additional info related to why the studies have been delayed

[String]

null

applicationRationale optional

Additional info related to how the student plans to finish his/her studies

[String]

null

StudyRightExtensionWorkflowApplication

Application related to StudyRightExtensionWorkflow.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot required

Plan

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightValidity required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this application was made

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the application was made

List of TermRegistration

null

usedAttendanceTerms required

The amount of used attendance terms at the time the application was made

[Integer] int32

null

usedAbsenceTerms required

The amount of used absence terms at the time the application was made

[Integer] int32

null

usedStatutoryAbsenceTerms required

The amount of used statutory absence terms at the time the application was made

[Integer] int32

null

termsWithoutRegistration required

The amount of study terms without a term registration at the time the application was made

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the application was made

Set of [string]

null

phase1Progress required

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms the student is requesting

[Integer] int32

null

delayRationale required

Additional info related to why the studies have been delayed

[String]

null

applicationRationale required

Additional info related to how the student plans to finish his/her studies

[String]

null

StudyRightExtensionWorkflowApplicationAllOf

Field Name Description Validation Schema Example

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot optional

Plan

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightValidity optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this application was made

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the application was made

List of TermRegistration

null

usedAttendanceTerms optional

The amount of used attendance terms at the time the application was made

[Integer] int32

null

usedAbsenceTerms optional

The amount of used absence terms at the time the application was made

[Integer] int32

null

usedStatutoryAbsenceTerms optional

The amount of used statutory absence terms at the time the application was made

[Integer] int32

null

termsWithoutRegistration optional

The amount of study terms without a term registration at the time the application was made

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the application was made

Set of [string]

null

phase1Progress optional

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms the student is requesting

[Integer] int32

null

delayRationale optional

Additional info related to why the studies have been delayed

[String]

null

applicationRationale optional

Additional info related to how the student plans to finish his/her studies

[String]

null

StudyRightExtensionWorkflowDecision

Decision for StudyRightExtensionWorkflow.

Field Name Description Validation Schema Example

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approvedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approverTitle optional

LocalizedString

null

approvalDate required

Date of decision.

NotNull

[date] date

null

resolutionRationale optional

Rationale for this decision.

Size(max = 8000, min = 0)

[String]

null

type required

Workflow decision type

[String]

null

administrativeReview required

ValidAdministrativeReview

AdministrativeReview

null

proposal optional

ValidProposal

Proposal

null

appealInstructions required

Instructions for the student on how to appeal the decision

[String]

null

grantedTerms optional

The amount of extra study terms granted to the student

[Integer] int32

null

extensionStartDate optional

The date when the granted study right extension starts

[date] date

null

extensionInfo optional

Additional info for the student related to the granted extension

[String]

null

StudyRightExtensionWorkflowDecisionAllOf

Field Name Description Validation Schema Example

administrativeReview optional

ValidAdministrativeReview

AdministrativeReview

null

proposal optional

ValidProposal

Proposal

null

appealInstructions optional

Instructions for the student on how to appeal the decision

[String]

null

grantedTerms optional

The amount of extra study terms granted to the student

[Integer] int32

null

extensionStartDate optional

The date when the granted study right extension starts

[date] date

null

extensionInfo optional

Additional info for the student related to the granted extension

[String]

null

StudyRightGraduation

Properties related to (ending by) graduation of study right

Field Name Description Validation Schema Example

phase1GraduationDate required

Date on which phase 1 (eg. bachelor's) of the study right ended because of graduation

NotNull

[date] date

null

phase2GraduationDate optional

Date on which phase 2 (eg. master's) of the study right ended because of graduation

[date] date

null

StudyRightLearningOpportunity

Person query parameters for study right learning opportunity.

Field Name Description Validation Schema Example

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

learningOpportunityId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

StudyRightMinorSelection

A minor selection for a StudyRight.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

validityPeriod optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

acceptorPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

acceptanceDate optional

The date that the selection was approved.

[date] date

null

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

ModuleGroupId
NotNull

[String]

otm-123456

selectionState required

State of study right minor selection. REQUESTED means student has requested a minor selection for approval. APPROVED means the minor selection has been approved. A student may approve a minor selection themselves if the modules of the minor selection moduleGroupId have StudyRightAcceptanceType of AUTOMATIC. Otherwise, a teacher must approve the selection.

NotNull

[String] enum REQUESTED, APPROVED,

null

selectionType required

Study right selection type

NotNull

[String] enum urn:code:study-right-selection-type:minor-study-right, urn:code:study-right-selection-type:open-university-course-unit, urn:code:study-right-selection-type:separate-studies-module, urn:code:study-right-selection-type:separate-studies-course-unit, urn:code:study-right-selection-type:none,

null

StudyRightModuleSelection

Module selection of study right

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

validityPeriod optional

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

acceptorPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

acceptanceDate optional

The date that the selection was approved.

[date] date

null

moduleGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

ModuleGroupId
NotNull

[String]

otm-123456

StudyRightPrimality

Describes the primary study right for a student at a given time period.

Field Name Description Validation Schema Example

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

startDate required

Start date of primality time period

NotNull

[date] date

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

StudyRightId
NotNull

[String]

otm-123456

endDate optional

End date of primality time period, automatically calculated

[date] date

null

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

personId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyRightPrimalityUpdateResult

Field Name Description Validation Schema Example

totalPersons optional

[Long] int64

null

totalStudents optional

[Long] int64

null

affectedStudents optional

[Long] int64

null

saveChanges optional

[Boolean]

null

StudyRightStatePeriod

DateRange that StudyRight has a specific state

Field Name Description Validation Schema Example

state required

NOT_STARTED means that study right starts in the future, and is not yet valid or active. ACTIVE means that the study right is active. ACTIVE_NONATTENDING means that study right is active but student is not attending to current term.RESCINDED means that the student has rescinded their study right. Study right can become PASSIVE for example when the student union dues have not been paid. Also, when student chooses one optional study right, it becomes active, and others become PASSIVE. Non-degree Study right can be EXPIRED, if it is no longer valid by validity date range.CANCELLED_BY_ADMINISTRATION means the study right is cancelled by administration, reason should be stated in cancellation object. GRADUATED means that there is an attainment for the education/study moduleTENTATIVE means that study right is for a cross study student and it is activated when student has successfully enrolled and accepted to a cur

Study right is automatically ended after valid.endDate is reached. There is no specific state for that.

[String] enum NOT_STARTED, ACTIVE, ACTIVE_NONATTENDING, GRADUATED, RESCINDED, CANCELLED_BY_ADMINISTRATION, TENTATIVE, DENIED, PASSIVE, EXPIRED,

null

startDate optional

Start date for the period

[date] date

null

endDate optional

End date for the period

[date] date

null

StudyRightTermRegistrations

Term registrations for a student for a single study right.

ValidStudyRightTermRegistrations

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

termRegistrations required

List of information objects about registrations, one for each term. Can be empty, at the beginning of the lifetime of the study right, when no registrations have been made and no registration deadlines have passed.

NotNull
ContainsNoNulls
Size(max = 400, min = 0)

List of TermRegistration

null

statePeriods optional

List of study right states for each time period. This is a readonly property, updated automatically based on term registrations and study right data

List of StudyRightStatePeriod

null

statePeriodOverrides optional

List of study right state periods that will override state calculation. These states will be merged to the automatically updated state periods.

ValidStatePeriodOverrides

List of StudyRightStatePeriod

null

state optional

NOT_STARTED means that study right starts in the future, and is not yet valid or active. ACTIVE means that the study right is active. ACTIVE_NONATTENDING means that study right is active but student is not attending to current term.RESCINDED means that the student has rescinded their study right. Study right can become PASSIVE for example when the student union dues have not been paid. Also, when student chooses one optional study right, it becomes active, and others become PASSIVE. Non-degree Study right can be EXPIRED, if it is no longer valid by validity date range.CANCELLED_BY_ADMINISTRATION means the study right is cancelled by administration, reason should be stated in cancellation object. GRADUATED means that there is an attainment for the education/study moduleTENTATIVE means that study right is for a cross study student and it is activated when student has successfully enrolled and accepted to a cur

Study right is automatically ended after valid.endDate is reached. There is no specific state for that.

[String] enum NOT_STARTED, ACTIVE, ACTIVE_NONATTENDING, GRADUATED, RESCINDED, CANCELLED_BY_ADMINISTRATION, TENTATIVE, DENIED, PASSIVE, EXPIRED,

null

StudyRightTermRegistrationsPatchEntity

A single patched study right term registration

Field Name Description Validation Schema Example

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

id optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

StudyRightTransfer

Properties related to transferred study right

Field Name Description Validation Schema Example

originalStartDate required

Date on which student originally has started studies

NotNull

[date] date

null

originalUniversityUrn optional

Represents Uniform Resource Names for educational institutions. Supported values available here

UrnCode(namespace = urn:code:educational-institution, onlySyntax = false)

[String]

urn:code:educational-institution:*

usedTerms optional

Count of used terms in previous university

Min(value = 0)

[Integer] int32

null

usedAbsenceTerms optional

Count of used absence terms in previous university

Min(value = 0)

[Integer] int32

null

usedStatutoryAbsenceTerms optional

Count of used statutory absence terms in previous university

Min(value = 0)

[Integer] int32

null

transferComments optional

Comments by staff related transfer

Size(max = 255, min = 0)

[String]

null

StudyTermLocator

Identifies a study term by its year, and term index.

Field Name Description Validation Schema Example

studyYearStartYear optional

The starting calendar year of the studyYear the term belongs to

[Integer] int32

null

termIndex optional

The index of the term within the studyYear

[Integer] int32

null

SubstituteFor

Field Name Description Validation Schema Example

substitutedCourseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

substitutedCredits optional

[BigDecimal]

null

TargetStudentGroup

Target student group i.e. kohderyhmä is meant to be used for grouping students, and using the group e.g. as basis for enrolment prioritisation. The group does not grant access permissions for student's information.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

LocalizedString

null

description optional

LocalizedString

null

updateType required

Manual groups must be updated by an administrator manually, while automatic groups are updated by running a student search periodically.

NotNull

[String] enum MANUAL, AUTOMATIC,

null

membershipUpdateTime optional

The time when memberships of this group was updated. Used only when updateType is AUTOMATIC.

[Date] date-time

null

membershipCheckTime optional

The time when memberships of this group was checked. Used only when updateType is AUTOMATIC.

[Date] date-time

null

responsibilityInfos required

Persons or roles in a responsibility relation to this group

NotNull [Active]
Size(max = 200, min = 0)
ContainsNoNulls

Set of PersonWithGroupResponsibilityInfoType

null

personQueries optional

List of conditions (joined by OR) for checking persons possible membership in this group. Unnecessary for MANUAL updateType.

ContainsNoNulls
Size(max = 20, min = 0)

List of PersonQuery

null

validMemberships optional

Number of valid memberships in group (read-only, only for group search)

[Integer] int32

null

type required

Group type

[String]

null

TemporalPatchEntity

A single temporal patch entity must include the 'id' parameter and 'snapshotDateTime' to identify which entity to apply the patch to, and any other fields to be changed. Can be used to create new temporal entities.

Field Name Description Validation Schema Example

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

snapshotDateTime required

Entity's snapshotDateTime. Other allowed values besides LocalDateTime: '-infinity' maps to beginning of time, 'currentSnapshot' resolves and uses current snapshot's snapshotDateTime, 'today' uses latest snapshot from today or creates a new one, 'now' generates new snapshotDateTime from now.

[String]

null

TermRegistration

Information about registration of one student in one study right for one study term.Contained within a StudyRight, which implies the student and the study right.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

studyTerm required

StudyTermLocator

null

registrationDate optional

Date of registration

[date] date

null

termRegistrationType required

Type of registration for one term. ATTENDING means that the registration has been done and the student is attending to that specific study term. NONATTENDING means that the registration has been done and the student is not attending to that specific study term. MISSING is auto generated value and means that the registration has not been done yet.

NotNull

[String] enum ATTENDING, NONATTENDING, MISSING, NEGLECTED,

null

previousRegistrationType optional

Type of registration for one term. ATTENDING means that the registration has been done and the student is attending to that specific study term. NONATTENDING means that the registration has been done and the student is not attending to that specific study term. MISSING is auto generated value and means that the registration has not been done yet.

[String] enum ATTENDING, NONATTENDING, MISSING, NEGLECTED,

null

previousRegistrationDate optional

Date of previous term registration if registration changed during the term.

[date] date

null

statutoryAbsence optional

This absence is statutory e.g. parental leave or military service

[Boolean]

null

statutoryAbsenceDate optional

Date of change for statutoryAbsence field

[date] date

null

statutoryAbsenceChangedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

tuitionFeePaymentState optional

Holds possible states of the yearly tuition fee ("Lukuvuosimaksu") payment of a study right

[String] enum PAID, OUTSTANDING,

null

TermRegistrationForStudyRight

Information about registration of one student in one study right for one study term.Implies the student and the study right.

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

[String]

otm-123456

studyTerm required

StudyTermLocator

null

registrationDate optional

Date of registration

[date] date

null

termRegistrationType required

Type of registration for one term. ATTENDING means that the registration has been done and the student is attending to that specific study term. NONATTENDING means that the registration has been done and the student is not attending to that specific study term. MISSING is auto generated value and means that the registration has not been done yet.

[String] enum ATTENDING, NONATTENDING, MISSING, NEGLECTED,

null

previousRegistrationType optional

Type of registration for one term. ATTENDING means that the registration has been done and the student is attending to that specific study term. NONATTENDING means that the registration has been done and the student is not attending to that specific study term. MISSING is auto generated value and means that the registration has not been done yet.

[String] enum ATTENDING, NONATTENDING, MISSING, NEGLECTED,

null

previousRegistrationDate optional

Date of previous term registration if registration changed during the term.

[date] date

null

statutoryAbsence optional

This absence is statutory e.g. parental leave or military service

[Boolean]

null

statutoryAbsenceDate optional

Date of change for statutoryAbsence field

[date] date

null

statutoryAbsenceChangedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

tuitionFeePaymentState optional

Holds possible states of the yearly tuition fee ("Lukuvuosimaksu") payment of a study right

[String] enum PAID, OUTSTANDING,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

TermRegistrationForStudyRightPatchEntity

A single patched term registration

Field Name Description Validation Schema Example

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

TermRegistrationPeriod

A university-specific period of time when study term registration is open. Term registration periods can't overlap; there can only be one open registration period at a time. One registration period can allow registering for one or two study terms (determined by the admin).

ValidTermRegistrationPeriod

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

universityOrgId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
OrganisationId

[String]

otm-123456

studyYearStartYear optional

The starting year of the study year for which this registration period is for

Min(value = 1900)
Max(value = 9999)

[Integer] int32

null

validityPeriod required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

term1 required

StudyTermLocator

null

term2 optional

StudyTermLocator

null

registrationInfo required

LocalizedString

null

studyRightRecoveryInfo optional

LocalizedString

null

Thesis

The thesis model.

ValidCourseUnitReference

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

attainmentId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

AttainmentId

[String]

otm-123456

title optional

LocalizedString

null

subject required

LocalizedString

null

thesisTypeUrn required

Supported types of thesis. Should match course unit types defined in CourseUnitTypeUrn.

NotNull
UrnCode(namespace = urn:code:thesis-type, onlySyntax = false)

[String]

urn:code:thesis-type:*

responsibilityInfos required

Employee(s) who are responsible for giving the thesis.

NotNull
ContainsNoNulls

Set of PersonWithAttainmentAcceptorType

null

organisations optional

Organisations responsible for this thesis in various ways and fractions. Typically the same list as in the related Attainment.

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

courseUnitId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
CourseUnitId

[String]

otm-123456

courseUnitGroupId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
CourseUnitGroupId

[String]

otm-123456

state required

The state of a thesis.

NotNull

[String] enum ATTAINED,

null

publicInspectionDate required

The public inspection date of the thesis.

[date] date

null

commissionType required

Whether the thesis is a commission, that is a collaboration with working life

NotNull

[String] enum NONE, COMMISSION,

null

TimelineNote

Note written by student, shown on timeline.

Field Name Description Validation Schema Example

text required

Note text

NotNull
Size(max = 255, min = 1)

[String]

null

notePeriods required

The periods of this note, not necessarily continuous.

NotNull
ContainsNoNulls

Set of [string]

null

TuitionFeeObligationPeriod

Represents a date range during which a study right has a tuition fee obligation ("Lukuvuosimaksuvelvollisuus"), i.e. when the student needs to pay a yearly tuition fee. A study right can have multiple such periods. The periods can't overlap, and the last period can be in effect indefinitely, which is indicated by a missing validity end date.

ValidTuitionFeeObligationPeriod

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
StudyRightId

[String]

otm-123456

valid required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

tuitionFee required

The yearly tuition fee that must be paid during this period.

NotNull
Min(value = 0)

[BigDecimal]

null

exempt required

If set to true, the student is exempt from the tuition fee obligation.

NotNull

[Boolean]

null

additionalInfo optional

LocalizedString

null

TuitionFeePayment

A tuition fee payment made by a student for a specific study right and study term.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

invalidated required

Is the payment invalidated

[Boolean]

null

invalidationRationale optional

Rationale for the invalidation of the payment, required if the payment is invalidated

Size(max = 8000, min = 0)

[String]

null

invalidatedBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

invalidationDate optional

Date of which the payment was invalidated

[date] date

null

paymentAmount required

Amount of the payment in euros

NotNull
Min(value = 0)

[BigDecimal]

null

paymentDate optional

Date on which the payment was made

[date] date

null

registeredBy optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId

[String]

otm-123456

source required

Source for payment creation, currently either PERSON or OILI

NotNull

[String] enum PERSON, OILI,

null

registrationDate required

Registration date for payment

NotNull

[date] date

null

studentId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

studyYearStartYear required

Study year which this payment is registered

NotNull

[Integer] int32

null

studyTerm optional

StudyTermLocator

null

type required

Defines the type of payment made by a student.

NotNull

[String] enum OILI_PAYMENT, TUITION_FEE_PAYMENT,

null

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

TutoringStudentGroup

Tutoring student group i.e. ohjausryhmä is meant for tutoring, messaging between tutor and student, and access permissions. Responsible tutors marked in the group are allowed to access student's information, attainments, plan, assessments etc.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

name required

LocalizedString

null

description optional

LocalizedString

null

updateType required

Manual groups must be updated by an administrator manually, while automatic groups are updated by running a student search periodically.

NotNull

[String] enum MANUAL, AUTOMATIC,

null

membershipUpdateTime optional

The time when memberships of this group was updated. Used only when updateType is AUTOMATIC.

[Date] date-time

null

membershipCheckTime optional

The time when memberships of this group was checked. Used only when updateType is AUTOMATIC.

[Date] date-time

null

responsibilityInfos required

Persons or roles in a responsibility relation to this group

NotNull [Active]
Size(max = 200, min = 0)
ContainsNoNulls

Set of PersonWithGroupResponsibilityInfoType

null

personQueries optional

List of conditions (joined by OR) for checking persons possible membership in this group. Unnecessary for MANUAL updateType.

ContainsNoNulls
Size(max = 20, min = 0)

List of PersonQuery

null

validMemberships optional

Number of valid memberships in group (read-only, only for group search)

[Integer] int32

null

type required

Group type

[String]

null

UpcomingStudiesFrontpageComponentSetting

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

UserSettings

Contains the settings and preferences for a user.

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

personId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

studentBetaFrontpageEnabled optional

Controls whether the student beta frontpage is enabled for this user.

[Boolean]

null

componentSettings optional

Settings for beta frontpage components

Map of [UserSettings_componentSettings_value]

null

id optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

UserSettingsComponentSettingsValue

Field Name Description Validation Schema Example

componentName required

Name of the frontpage components/widgets

NotNull

[String] enum app-active-studies, app-upcoming-studies, app-recent-attainments, app-study-progress-graph,

null

isHidden optional

Controls whether the component is visible on the frontpage the current user.

[Boolean]

null

studyRightId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

Workflow

A workflow

ValidWorkflow

Field Name Description Validation Schema Example

documentState optional

DocumentState determines whether a document is visible to public, students or staff.

[String] enum DRAFT, ACTIVE, DELETED,

null

id required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull

[String]

otm-123456

state required

State in which the workflow currently is. Some states (REJECTED, ACCEPTED, CONDITIONAL and REVOKED) require additional information to be added for the workflow, such as a workflow decision.

NotNull

[String] enum REQUESTED, REJECTED, ACCEPTED, IN_HANDLING, CANCELLED, CONDITIONAL, REVOKED, ACCEPTANCE_REVOKED, SUPPLEMENT_REQUESTED,

null

code required

Human-readable, preferrably short (but with at least three characters) code for this workflow. Generated if not set.

Size(max = 255, min = 3)
NotNull

[String]

null

lastHandlerPersonId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId

[String]

otm-123456

lastHandledTime optional

Last time this workflow was handled

[Date] date-time

null

assignedHandlerId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

creationTime required

Original workflow creation time

NotNull

[Date] date-time

null

organisations optional

Organisations responsible for this workflow in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

application optional

[Workflow_application]

null

applicationHistory optional

Previous applications that are related to this workflow

ContainsNoNulls

List of [Workflow_applicationHistory_inner]

null

decision optional

[Workflow_decision]

null

decisionHistory optional

Previous decisions that are related to this workflow

ContainsNoNulls

List of [Workflow_decisionHistory_inner]

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PrivatePersonId
NotNull

[String]

otm-123456

type required

Workflow type

[String]

null

WorkflowApplication

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

name required

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher required

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale required

Additional info related to how the student plans to finish his/her studies

[String]

null

attainmentDescription required

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits required

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

planContent optional

ModuleContent

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding graduation application given by student.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when application is related to last phase of education. Should be null otherwise.

[Boolean]

null

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot required

Plan

null

studyRightValidity required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this application was made

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the application was made

List of TermRegistration

null

usedAttendanceTerms required

The amount of used attendance terms at the time the application was made

[Integer] int32

null

usedAbsenceTerms required

The amount of used absence terms at the time the application was made

[Integer] int32

null

usedStatutoryAbsenceTerms required

The amount of used statutory absence terms at the time the application was made

[Integer] int32

null

termsWithoutRegistration required

The amount of study terms without a term registration at the time the application was made

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the application was made

Set of [string]

null

phase1Progress required

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms the student is requesting

[Integer] int32

null

delayRationale required

Additional info related to why the studies have been delayed

[String]

null

WorkflowApplicationHistoryInner

Field Name Description Validation Schema Example

localId required

Unique identifier within some local context. Context must be defined in use site api documentation.

Allowable values are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long.

NotNull

[String]

otm-123456

creationTime required

Original application creation time

NotNull

[Date] date-time

null

createdByPersonId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

NotNull
PrivatePersonId

[String]

otm-123456

organisations optional

Organisations responsible for this application in various ways and fractions. Typically the same list as in the related CourseUnit or StudyModule

ValidSetOfOrganisationRoleShareBase [Active]
ContainsNoNulls

Set of OrganisationRoleShareBase

null

type required

Application type

[String]

null

mustPrintDecision optional

Whether or not student has requested the decision and other outcome of the application to be printed and mailed to a physical address

[Boolean]

null

planId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

studyRightId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

name required

Descriptive name of the application

[String]

null

plannedParentModuleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

degreeProgrammeGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

responsibleTeacher required

The teacher to whom the student talked about this attainment

[String]

null

applicationRationale required

Additional info related to how the student plans to finish his/her studies

[String]

null

attainmentDescription required

Description what has been done and/or agreed with the teacher

[String]

null

plannedCredits required

Planned credits

[BigDecimal]

null

customStudyDraft optional

CustomStudyDraft

null

attainmentLanguage optional

Represents Uniform Resource Names for languages. Supported values available here

[String]

urn:code:language:*

moduleId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

educationId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

parentModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

approvedModuleId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

originalReferredPlanId required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

moduleSelections required

Module group ids of the modules student selected for approval

List of [string]

null

courseUnitSelections required

Course unit group ids of the course units student selected for approval

List of [string]

null

customModuleAttainmentSelections required

Ids of the custom module attainments student selected for approval

List of [string]

null

customCourseUnitAttainmentSelections required

Ids of the custom course unit attainments student selected for approval

List of [string]

null

customStudyDrafts required

Custom study drafts the student has added into the module

List of CustomStudyDraft

null

planContent optional

ModuleContent

null

degreeDeliveryMethod required

Type of delivery for degree certificate.

[String] enum MAIL, PICK_UP, DIGITAL_CERTIFICATE,

null

deliveryAddress optional

Address

null

additionalInfo optional

Additional information regarding graduation application given by student.

[String]

null

joinsAlumniAssociation optional

Indicates whether the student has decided to join alumni association. Decision is made only when application is related to last phase of education. Should be null otherwise.

[Boolean]

null

questionnaireAnswers optional

Answers to questionnaire

Set of DegreeProgrammeAttainmentApplicationAnswer

null

priorLearnings optional

List of all prior learnings that should be considered within this application.

List of PriorLearning

null

courseUnitId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

courseUnitGroupId optional

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

[String]

otm-123456

planSnapshot required

Plan

null

studyRightValidity required

FieldsOrdered(allowEqual = false, greaterField = endDate, lesserField = startDate)

LocalDateRange

null

previousExtensions optional

Previous study right extensions that were granted before this application was made

List of StudyRightExtension

null

termRegistrations optional

Term registrations for the study right at the time the application was made

List of TermRegistration

null

usedAttendanceTerms required

The amount of used attendance terms at the time the application was made

[Integer] int32

null

usedAbsenceTerms required

The amount of used absence terms at the time the application was made

[Integer] int32

null

usedStatutoryAbsenceTerms required

The amount of used statutory absence terms at the time the application was made

[Integer] int32

null

termsWithoutRegistration required

The amount of study terms without a term registration at the time the application was made

[Integer] int32

null

attainmentIds optional

The valid attainments that were in the plan at the time the application was made

Set of [string]

null

phase1Progress required

EducationPhaseProgress

null

phase2Progress optional

EducationPhaseProgress

null

requestedTerms optional

The amount of additional study terms the student is requesting

[Integer] int32

null

delayRationale required

Additional info related to why the studies have been delayed

[String]

null

WorkflowDecision

Field Name Description Validation Schema Example

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approvedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approverTitle optional

LocalizedString

null

approvalDate required

Date of decision.

NotNull

[date] date

null

resolutionRationale optional

Rationale for this decision.

Size(max = 8000, min = 0)

[String]

null

type required

Workflow decision type

[String]

null

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

appealInstructions required

Instructions for the student on how to appeal the decision

[String]

null

conditionalApprovalTerms optional

Conditional approval terms for this approval

[String]

null

administrativeReview required

ValidAdministrativeReview

AdministrativeReview

null

proposal optional

ValidProposal

Proposal

null

grantedTerms optional

The amount of extra study terms granted to the student

[Integer] int32

null

extensionStartDate optional

The date when the granted study right extension starts

[date] date

null

extensionInfo optional

Additional info for the student related to the granted extension

[String]

null

WorkflowDecisionHistoryInner

Field Name Description Validation Schema Example

registeredBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approvedBy required

Unique identifier within source system. Prefixed with a source system specific prefix, guaranteeing uniqueness also locally.

Allowable prefix values are 1 to 5 characters (a-z, A-Z) long. Allowable postfixes are 1 to 58 characters (a-z, A-Z, 0-9, dash (-) or underscore (_)) long. The separator is a dash (-).

PublicPersonId
NotNull

[String]

otm-123456

approverTitle optional

LocalizedString

null

approvalDate required

Date of decision.

NotNull

[date] date

null

resolutionRationale optional

Rationale for this decision.

Size(max = 8000, min = 0)

[String]

null

type required

Workflow decision type

[String]

null

formalRecommendation optional

Recommendation

null

contentRecommendation optional

Recommendation

null

appealInstructions required

Instructions for the student on how to appeal the decision

[String]

null

conditionalApprovalTerms optional

Conditional approval terms for this approval

[String]

null

administrativeReview required

ValidAdministrativeReview

AdministrativeReview

null

proposal optional

ValidProposal

Proposal

null

grantedTerms optional

The amount of extra study terms granted to the student

[Integer] int32

null

extensionStartDate optional

The date when the granted study right extension starts

[date] date

null

extensionInfo optional

Additional info for the student related to the granted extension

[String]

null

Validations

ActiveAssessmentItemId

Validates that referenced assessment item is ACTIVE when given attainment is not DRAFT/DELETED and not misregistered.

ActiveCourseUnitId

Validates that referenced course unit is ACTIVE when given attainment is not DRAFT/DELETED and not misregistered.

ActiveModuleId

Validates that referenced module is ACTIVE when given attainment is not DRAFT/DELETED and not misregistered.

AdmissionTargetId

OtmId or OtmIds which must refer to AdmissionTargets

AssessmentItemId

OtmId or set of OtmIds which must refer to AssessmentItems of any state, which need not necessarily exist at the present time.

AttainedQualificationId

OtmId or set of OtmIds which must refer to AttainedQualifications of any state.

AttainmentId

OtmId or set of OtmIds which must refer to Attainments of any state.

ContainsNoNulls

Collection may not contain null elements.

CooperationNetworkId

OtmId or set of OtmIds which must refer by groupId to CourseUnits of any state.

CourseUnitGroupId

OtmId or set of OtmIds which must refer by groupId to CourseUnits of any state.

CourseUnitId

OtmId or set of OtmIds which must refer to CourseUnits of any state.

CourseUnitRealisationId

OtmId or set of OtmIds which must refer to non-DELETED CourseUnitRealisations.

CurriculumPeriodId

OtmId or set of OtmIds which must refer to ACTIVE CurriculumPeriods.

DegreeProgrammeId

OtmId or set of OtmIds which must refer to DegreeProgrammes of any state.

DisclosureAuthorizationCategoryId

OtmId or set of OtmIds which must refer to ACTIVE DisclosureAuthorizationCategoriess.

EducationId

OtmId or set of OtmIds which must refer to non-DELETED Educations.

EndDateRequired

LocalDateRange with non-null endDate.

EnrolmentRightId

OtmId or set of OtmIds which must refer to an EnrolmentRight.

EntityWithRuleId

OtmId or set of OtmIds which must refer to EntityWithRuleIds (Education, DegreeProgramme,StudyModule, or GroupingModule) of any state.

FieldsNotNullWhenConditionTrue

Conditionally check that a collection of fields are not null.

FieldsOrdered

Check that lesserField compares before (or equal to, if explicitly allowed) greaterField. If either value is null, the validation passes.

GradeScaleId

OtmId or set of OtmIds which must refer to ACTIVE GradeScales.

InternationalContractualDegreeAgreementId

OtmId or set of OtmIds which must refer to a international contractual degree agreement.

LocalizedStringSize

Check minimum and maximum size of localized string types.

ModuleGroupId

OtmId or set of OtmIds which must refer by groupId to Modules (StudyModule, DegreeProgramme, or GroupingModule) of any state.

NonOverlappingCooperationNetworkRights

Validates that validity periods of given cooperation network rights (grouped by cooperation network id) do not overlap

NonOverlappingStudyRightCourseUnitSelections

Validates that given study right has course unit selections (grouped by group id) that do not overlap

NonOverlappingStudyRightModuleSelections

Validates that given study right has module selections (grouped by group id) that do not overlap

NotEmptyAcceptorPersons

Validates that the acceptor persons collection is not empty or null

NotEmptyEnrolmentRightEnrolmentConstraints

Validates that other than SUBSTITUTION enrolment rights have enrolment constraints.

NotNullEnrolmentRightCompletionMethodId

Validates that other than SUBSTITUTION enrolment rights have a completion method.

OpenUniversityCartId

OtmId or set of OtmIds which must refer to OpenUniversityCarts of any state.

OrganisationId

OtmId or set of OtmIds which must refer to ACTIVE Organisations.

PrivatePersonId

OtmId or set of OtmIds which must refer to ACTIVE PrivatePersons (persons in Ori).

PublicPersonId

OtmId or set of OtmIds which must refer to ACTIVE PublicPersons (persons in Kori).

QualificationId

OtmId or set of OtmIds which must refer to Qualifications of any state.

SecondPhaseEducationLocationNotNullForTwoLevelStudies

Second phase of StudyRight must have EducationLocation, if the education is two-phased.

SomeFieldsNotNull

Count nulls in a collection of fields and validate the number is between bounds.

StartDateRequired

LocalDateRange with non-null startDate.

StudyRightId

OtmId or set of OtmIds which must refer to a study right.

UrnCode

Structurally correct UrnCode of form urn:code:<codebook>:<value> where the validity of codebook and value is checked against known data.

ValidAdministrativeReview

Validates that the reviewer and title are given when the review result is performed.

ValidAttainedQualification

Check that the AttainedQualification has valid properties.

ValidAttainmentDate

Require attainmentDate to be the present date or earlier.

ValidAttainmentEnrolmentRight

Validates that referenced enrolment right is valid on attainment date and belongs to the same student

ValidAttainmentStudyRightAndTermRegistrations

Validates that referenced student has active study right and no non-attending term registrations on attainment date

ValidAttainmentStudyRightId

Validates that study right id references student’s own study right.

ValidCollaborationInstitution

Validates that collaboration institution specifies either a national institution or an international institution by using the special educationalInstitution codes for foreign institutions

ValidCooperationNetworkStatusAndRights

Validates that only cooperation network status or cooperation network rights are defined for study right.

ValidCourseUnitReference

Validates the integrity of the referenced courseUnitId and courseUnitGroupId

ValidCreditTransferAttainment

Validates that attainment with status 'ATTAINED' does not have credit transfer information

ValidCreditTransferInfo

Validates credit transfer information

ValidDegreeProgrammeAttainmentApplicationAnswer

Validates that answer is valid.

ValidEntityWithEnrolmentConstraints

Validates that all allowed teaching defined in the enrolment constraints is organized (at least partly) during the validity period of the entity, and that the completion method and assessment item references are valid in the context of the referenced course unit.

ValidFinnAuthId

Check that the finnAuthId is in valid form, including the checksum.

ValidGrant

Checks that the grant is valid

ValidHomeOrganisation

Validates that the homeOrganisation field is not null for study rights referencing an education of type agreement studies, and null for all other study rights.

ValidInternationalContractualDegree

Checks that international contractual degree is valid.

ValidLegacyPrivatePerson

It is mandatory for PrivatePerson to have either firstNames or lastName

ValidMobilityPeriod

Checks that moobility period is valid

ValidModuleAttainmentWorkflow

Only one ModuleAttainmentWorkflow per module per student can be in states + (IN_HANDLING, REQUESTED)

ValidModuleContentWorkflowApplication

Validates that the content of the ModuleContentWorkflowApplication is valid (not empty, no duplicate selections

ValidModuleReference

Validates the integrity of the referenced moduleId and moduleGroupId

ValidOppijaID

Check OppijaID is a valid OID, that its prefix is 1.2.246.562.24, its suffix is 11 decimal digits, and that the checksum in the suffix is correct.

ValidOrganisationRoleShare

Check validity of a single OrganisationRoleShare

ValidPersonalIdentificationCode

Check that the Finnish hetu is in valid form, including the checksum.

ValidPersonalizedPhase

Checks that personalized phase is valid.

ValidPersonalizedSelectionPath

Checks that personalized selectionpath is valid, at the moment only checks that it contains phase 1.

ValidPlan

Check rootId is found in moduleSelections, with null parentModuleId. Check for each moduleSelection that parentModuleId, if not null, is found in moduleSelections. Check for each courseUnitSelection that parentModuleId, if not null, is found in moduleSelections and that each substitutedBy is found in courseUnitSelections. Check for each assessmentItemSelection that courseUnitId is found in courseUnitSelections.

ValidPrimaryAttainment

A primary attainment is not allowed to be FAILED, or marked as a misregistration. Only successfully attained primary attainments can be attached to parent attainments

ValidPriorLearningSubstitutionWorkflow

Only one active PriorLearningSubstitutionWorkflow per student id and course unit group id is allowedwhen application state is not REJECTED or CANCELLED

ValidPrivatePerson

If citizenshipUrns is urn:code:country:246 or urn:code:country:248 and studentStatus is ACTIVE, personalIdentityCode is mandatory. If citizenshipUrns is not urn:code:country:246 (fi) or urn:code:country:248 (ahvenanmaa) and studentStatus is ACTIVE, dateOfBirth is mandatory.

ValidProposal

Validates that the reviewer and title are given when the review result is performed.

ValidRdiPoints

Validates Rdi points (AMK) based on attainment, only for AIA,CUA and CCUA.

ValidSanitized

Check string has no vulnerable XSS fields.

ValidSetOfOrganisationRoleShareBase

Check that for each roleUrn the sum of shares over the entire set is equal to 1.

ValidStatePeriodOverrides

Checks that state period overrides is a valid list of overriding state periods.

ValidStudentPayment

Validates that an invalidated student payment also has a rational for invalidation.

ValidStudyFieldAndClassifications

Checks that non degree study rights have a study field and degree study rights have education classification per phase.

ValidStudyRight

Checks that study right is valid, learning opportunity exists in selected education, and selection paths match education structure and learning opportunity.

ValidStudyRightBasedOnStudySelections

Checks that study right is valid if its expiring rule is based-on-study-selections.

ValidStudyRightCancellation

Checks that study right cancellation is valid.

ValidStudyRightExtension

Checks that deleted study rights have all deletion-related mandatory fields set

ValidStudyRightExtensionWorkflow

Validates that the workflow, study right and study plan are in sync with each other.

ValidStudyRightTermRegistrations

Checks that study right term registrations is valid in a sense that duplicate term registrations do not exist.

ValidSubstitution

Validates substitution of attainment

ValidTermRegistration

Checks that a term registration is valid

ValidTermRegistrationPeriod

Validates that the study terms associated with this registration period belong to the same study year for which this registration period is for.

ValidThesis

Ensure theses that have state ATTAINED have all appropriate fields set.

ValidTuitionFeeObligationPeriod

Checks that the period validity is within the study right validity, and that it does not overlap with other tuition fee obligation periods.

ValidWorkflow

Checks that the workflow data is consistent.

WorkflowId

OtmId or set of OtmIds which must refer to a workflow.