Sign in

v2

latestOpenAPI 3.1.0Proprietary - Licensed to Authorized Customers Only2026-07-31611061.1 MB
Guardian

Create a new Guardian

Create a new Guardian

post/guardian

Request body

identityNumberstring required

The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization.

identityTemporaryboolean

If the identity number is temporary for the guardian

firstNamestring required

The first name of the guardian

lastNamestring required

The last name of the guardian

emailAddress1string nullable

The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

emailAddress2string nullable

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

phoneNumber1string nullable

The primary phone number of the guardian, will be used for communication with the guardian from the system.

phoneNumber2string nullable

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

studentIDsstring[]

The IDs of the students the guardian is responsible for.

Example request

{
  "external": {
    "sourceID": "12345678"
  },
  "identityNumber": "20191216-1234",
  "identityTemporary": true,
  "firstName": "Lise",
  "lastName": "Meitner",
  "address": {
    "postalAddress": "Dalvägen 14",
    "postalCode": "169 56",
    "postalCity": "Solna",
    "countryCode": "SWE",
    "municipalityCode": "0184"
  },
  "emailAddress1": "lise@meitner.se",
  "emailAddress2": "lise@gmail.com",
  "phoneNumber1": "+46701234567",
  "phoneNumber2": "+46701234567",
  "studentIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Response

Response for Guardian Create operation - returns the created Guardian

idstring uuid required

Unique identifier for the Guardian

identityNumberstring required

The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization.

identityTemporaryboolean

If the identity number is temporary for the guardian

firstNamestring required

The first name of the guardian

lastNamestring required

The last name of the guardian

emailAddress1string nullable

The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

emailAddress2string nullable

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

phoneNumber1string nullable

The primary phone number of the guardian, will be used for communication with the guardian from the system.

phoneNumber2string nullable

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

studentIDsstring[]

The IDs of the students the guardian is responsible for.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
    "updatedAt": "2024-01-15T14:45:00Z",
    "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
  },
  "external": {
    "sourceID": "12345678",
    "source": "ExternalIntegrationAPI"
  },
  "identityNumber": "20191216-1234",
  "identityTemporary": true,
  "firstName": "Lise",
  "lastName": "Meitner",
  "address": {
    "postalAddress": "Dalvägen 14",
    "postalCode": "169 56",
    "postalCity": "Solna",
    "countryCode": "SWE",
    "municipalityCode": "0184"
  },
  "emailAddress1": "lise@meitner.se",
  "emailAddress2": "lise@gmail.com",
  "phoneNumber1": "+46701234567",
  "phoneNumber2": "+46701234567",
  "studentIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}