Csharp (SDK)
using Meitner;
using Meitner.Models.Components;
using System;
var sdk = new MeitnerSDK(security: new Security() {
Option1 = new SecurityOption1() {
ClientCredentials = "<YOUR_API_KEY_HERE>",
ClientSecret = "<YOUR_API_KEY_HERE>",
},
});
StudentCreate req = new StudentCreate() {
External = new StudentCreateExternal() {
SourceID = "12345678",
},
Gender = StudentCreateGender.Female,
IdentityNumber = "20191216-1234",
IdentityTemporary = true,
FirstName = "Lise",
LastName = "Meitner",
DateOfBirth = DateOnly.Parse("2019-12-16"),
Address = new StudentCreateAddress() {
PostalAddress = "Dalvägen 14",
PostalCode = "169 56",
PostalCity = "Solna",
CountryCode = "SWE",
MunicipalityCode = "0184",
},
EmailAddress1 = "lise@meitner.se",
EmailAddress2 = "lise@gmail.com",
PhoneNumber1 = "+46701234567",
PhoneNumber2 = "example",
EduPersonPrincipalName = "kalko@edu.goteborg.se",
};
var res = await sdk.Students.CreateAsync(req);
// handle responsefrom datetime import date
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
option1=models.SecurityOption1(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
),
) as m_client:
res = m_client.students.create(identity_number="20191216-1234", first_name="Lise", last_name="Meitner", external={
"source_id": "12345678",
}, gender="Female", identity_temporary=True, date_of_birth=date.fromisoformat("2019-12-16"), address={
"postal_address": "Dalvägen 14",
"postal_code": "169 56",
"postal_city": "Solna",
"country_code": "SWE",
"municipality_code": "0184",
}, email_address1="lise@meitner.se", email_address2="lise@gmail.com", phone_number1="+46701234567", phone_number2="example", edu_person_principal_name="kalko@edu.goteborg.se")
# Handle response
print(res)curl --request POST \
--url https://api.meitner.se/directory/v1/student \
--header 'Client-ID: <api-key>' \
--header 'Client-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"external": {
"sourceID": "12345678"
},
"gender": "Female",
"identityNumber": "20191216-1234",
"identityTemporary": true,
"firstName": "Lise",
"lastName": "Meitner",
"dateOfBirth": "2019-12-16",
"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": "example",
"eduPersonPrincipalName": "kalko@edu.goteborg.se"
}
'const options = {
method: 'POST',
headers: {
'Client-ID': '<api-key>',
'Client-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external: {sourceID: '12345678'},
gender: 'Female',
identityNumber: '20191216-1234',
identityTemporary: true,
firstName: 'Lise',
lastName: 'Meitner',
dateOfBirth: '2019-12-16',
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: 'example',
eduPersonPrincipalName: 'kalko@edu.goteborg.se'
})
};
fetch('https://api.meitner.se/directory/v1/student', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meitner.se/directory/v1/student",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external' => [
'sourceID' => '12345678'
],
'gender' => 'Female',
'identityNumber' => '20191216-1234',
'identityTemporary' => true,
'firstName' => 'Lise',
'lastName' => 'Meitner',
'dateOfBirth' => '2019-12-16',
'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' => 'example',
'eduPersonPrincipalName' => 'kalko@edu.goteborg.se'
]),
CURLOPT_HTTPHEADER => [
"Client-ID: <api-key>",
"Client-Secret: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meitner.se/directory/v1/student"
payload := strings.NewReader("{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-ID", "<api-key>")
req.Header.Add("Client-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.meitner.se/directory/v1/student")
.header("Client-ID", "<api-key>")
.header("Client-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meitner.se/directory/v1/student")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-ID"] = '<api-key>'
request["Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}"
response = http.request(request)
puts response.read_body{
"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"
},
"gender": "Female",
"identityNumber": "20191216-1234",
"identityTemporary": true,
"firstName": "Lise",
"lastName": "Meitner",
"dateOfBirth": "2019-12-16",
"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": "example",
"eduPersonPrincipalName": "kalko@edu.goteborg.se"
}{
"error": {
"code": "BadRequest",
"message": "The request contains invalid parameters or malformed data",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Forbidden",
"message": "You do not have permission to perform this operation",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NotFound",
"message": "The requested resource could not be found",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Conflict",
"message": "The request conflicts with the current state of the resource",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UnprocessableEntity",
"message": "Validation failed for Student Create endpoint",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RateLimited",
"message": "Too many requests - rate limit exceeded",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Internal",
"message": "An unexpected server error occurred",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}Student
Create a new Student
Create a new Student
POST
/
student
Csharp (SDK)
using Meitner;
using Meitner.Models.Components;
using System;
var sdk = new MeitnerSDK(security: new Security() {
Option1 = new SecurityOption1() {
ClientCredentials = "<YOUR_API_KEY_HERE>",
ClientSecret = "<YOUR_API_KEY_HERE>",
},
});
StudentCreate req = new StudentCreate() {
External = new StudentCreateExternal() {
SourceID = "12345678",
},
Gender = StudentCreateGender.Female,
IdentityNumber = "20191216-1234",
IdentityTemporary = true,
FirstName = "Lise",
LastName = "Meitner",
DateOfBirth = DateOnly.Parse("2019-12-16"),
Address = new StudentCreateAddress() {
PostalAddress = "Dalvägen 14",
PostalCode = "169 56",
PostalCity = "Solna",
CountryCode = "SWE",
MunicipalityCode = "0184",
},
EmailAddress1 = "lise@meitner.se",
EmailAddress2 = "lise@gmail.com",
PhoneNumber1 = "+46701234567",
PhoneNumber2 = "example",
EduPersonPrincipalName = "kalko@edu.goteborg.se",
};
var res = await sdk.Students.CreateAsync(req);
// handle responsefrom datetime import date
from meitner import Meitner, models
import os
with Meitner(
security=models.Security(
option1=models.SecurityOption1(
client_credentials=os.getenv("MEITNER_CLIENT_CREDENTIALS", ""),
client_secret=os.getenv("MEITNER_CLIENT_SECRET", ""),
),
),
) as m_client:
res = m_client.students.create(identity_number="20191216-1234", first_name="Lise", last_name="Meitner", external={
"source_id": "12345678",
}, gender="Female", identity_temporary=True, date_of_birth=date.fromisoformat("2019-12-16"), address={
"postal_address": "Dalvägen 14",
"postal_code": "169 56",
"postal_city": "Solna",
"country_code": "SWE",
"municipality_code": "0184",
}, email_address1="lise@meitner.se", email_address2="lise@gmail.com", phone_number1="+46701234567", phone_number2="example", edu_person_principal_name="kalko@edu.goteborg.se")
# Handle response
print(res)curl --request POST \
--url https://api.meitner.se/directory/v1/student \
--header 'Client-ID: <api-key>' \
--header 'Client-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"external": {
"sourceID": "12345678"
},
"gender": "Female",
"identityNumber": "20191216-1234",
"identityTemporary": true,
"firstName": "Lise",
"lastName": "Meitner",
"dateOfBirth": "2019-12-16",
"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": "example",
"eduPersonPrincipalName": "kalko@edu.goteborg.se"
}
'const options = {
method: 'POST',
headers: {
'Client-ID': '<api-key>',
'Client-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external: {sourceID: '12345678'},
gender: 'Female',
identityNumber: '20191216-1234',
identityTemporary: true,
firstName: 'Lise',
lastName: 'Meitner',
dateOfBirth: '2019-12-16',
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: 'example',
eduPersonPrincipalName: 'kalko@edu.goteborg.se'
})
};
fetch('https://api.meitner.se/directory/v1/student', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meitner.se/directory/v1/student",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'external' => [
'sourceID' => '12345678'
],
'gender' => 'Female',
'identityNumber' => '20191216-1234',
'identityTemporary' => true,
'firstName' => 'Lise',
'lastName' => 'Meitner',
'dateOfBirth' => '2019-12-16',
'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' => 'example',
'eduPersonPrincipalName' => 'kalko@edu.goteborg.se'
]),
CURLOPT_HTTPHEADER => [
"Client-ID: <api-key>",
"Client-Secret: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meitner.se/directory/v1/student"
payload := strings.NewReader("{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-ID", "<api-key>")
req.Header.Add("Client-Secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.meitner.se/directory/v1/student")
.header("Client-ID", "<api-key>")
.header("Client-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meitner.se/directory/v1/student")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-ID"] = '<api-key>'
request["Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external\": {\n \"sourceID\": \"12345678\"\n },\n \"gender\": \"Female\",\n \"identityNumber\": \"20191216-1234\",\n \"identityTemporary\": true,\n \"firstName\": \"Lise\",\n \"lastName\": \"Meitner\",\n \"dateOfBirth\": \"2019-12-16\",\n \"address\": {\n \"postalAddress\": \"Dalvägen 14\",\n \"postalCode\": \"169 56\",\n \"postalCity\": \"Solna\",\n \"countryCode\": \"SWE\",\n \"municipalityCode\": \"0184\"\n },\n \"emailAddress1\": \"lise@meitner.se\",\n \"emailAddress2\": \"lise@gmail.com\",\n \"phoneNumber1\": \"+46701234567\",\n \"phoneNumber2\": \"example\",\n \"eduPersonPrincipalName\": \"kalko@edu.goteborg.se\"\n}"
response = http.request(request)
puts response.read_body{
"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"
},
"gender": "Female",
"identityNumber": "20191216-1234",
"identityTemporary": true,
"firstName": "Lise",
"lastName": "Meitner",
"dateOfBirth": "2019-12-16",
"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": "example",
"eduPersonPrincipalName": "kalko@edu.goteborg.se"
}{
"error": {
"code": "BadRequest",
"message": "The request contains invalid parameters or malformed data",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Forbidden",
"message": "You do not have permission to perform this operation",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NotFound",
"message": "The requested resource could not be found",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Conflict",
"message": "The request conflicts with the current state of the resource",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UnprocessableEntity",
"message": "Validation failed for Student Create endpoint",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RateLimited",
"message": "Too many requests - rate limit exceeded",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "Internal",
"message": "An unexpected server error occurred",
"requestID": "550e8400-e29b-41d4-a716-446655440000"
}
}Authorizations
ClientCredentials & ClientSecretOAuth2
Body
application/json
Request body
The identity number of the student in the format YYYYMMDD-NNNN, must be unique within the organization.
Example:
"20191216-1234"
The first name of the student
Example:
"Lise"
The last name of the student
Example:
"Meitner"
ExternalRequest is the External-object used on Update and Create operations, since it should only be allowed to set SourceID for the student, the Source-field is not included.
Show child attributes
Show child attributes
Example:
{ "sourceID": "12345678" }
The gender of the student
Available options:
Female, Male, Other Example:
"Female"
If the identity number is temporary for the student
Example:
true
The date of birth of the student
Examples:
"2019-12-16"
null
The address of the student
Show child attributes
Show child attributes
Example:
{
"postalAddress": "Dalvägen 14",
"postalCode": "169 56",
"postalCity": "Solna",
"countryCode": "SWE",
"municipalityCode": "0184"
}
The primary email address of the student, will be used for communication with the student 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.
Examples:
"lise@meitner.se"
null
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
Examples:
"lise@gmail.com"
null
The primary phone number of the student, will be used for communication with the student from the system.
Examples:
"+46701234567"
null
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
Examples:
"example"
null
The eduPersonPrincipalName (EPPN) of the student, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster).
Format: localIdentifier@domain — e.g. kalko@edu.goteborg.se
Examples:
"kalko@edu.goteborg.se"
null
Response
Response for Student Create operation - returns the created Student
Student holds the personal information about a student, information about the school is stored in the StudentPlacement-resource.
Unique identifier for the Student
Example:
"123e4567-e89b-12d3-a456-426614174000"
The identity number of the student in the format YYYYMMDD-NNNN, must be unique within the organization.
Example:
"20191216-1234"
The first name of the student
Example:
"Lise"
The last name of the student
Example:
"Meitner"
Metadata information for the Student
Show child attributes
Show child attributes
Example:
{
"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 is a reusable object that can be used to store external information about the student from another system, used for third-party integration tracking.
Show child attributes
Show child attributes
Example:
{
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
}
The gender of the student
Available options:
Female, Male, Other Example:
"Female"
If the identity number is temporary for the student
Example:
true
The date of birth of the student
Examples:
"2019-12-16"
null
The address of the student
Show child attributes
Show child attributes
Example:
{
"postalAddress": "Dalvägen 14",
"postalCode": "169 56",
"postalCity": "Solna",
"countryCode": "SWE",
"municipalityCode": "0184"
}
The primary email address of the student, will be used for communication with the student 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.
Examples:
"lise@meitner.se"
null
The secondary email address of the student, will not be used within the system, but will be displayed for contact information.
Examples:
"lise@gmail.com"
null
The primary phone number of the student, will be used for communication with the student from the system.
Examples:
"+46701234567"
null
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
Examples:
"example"
null
The eduPersonPrincipalName (EPPN) of the student, as defined in the SS12000:2020 standard (TK450). A globally unique, persistent identifier used to identify users across Swedish e-services (e-tjänster).
Format: localIdentifier@domain — e.g. kalko@edu.goteborg.se
Examples:
"kalko@edu.goteborg.se"
null