using Meitner;
using Meitner.Models.Components;
var sdk = new MeitnerSDK(security: new Security() {
Option1 = new SecurityOption1() {
ClientCredentials = "<YOUR_API_KEY_HERE>",
ClientSecret = "<YOUR_API_KEY_HERE>",
},
});
var res = await sdk.Students.GetAsync(id: "123e4567-e89b-12d3-a456-426614174000");
// handle responsefrom 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.get(id="123e4567-e89b-12d3-a456-426614174000")
# Handle response
print(res)curl --request GET \
--url https://api.meitner.se/directory/v1/student/{id} \
--header 'Client-ID: <api-key>' \
--header 'Client-Secret: <api-key>'const options = {
method: 'GET',
headers: {'Client-ID': '<api-key>', 'Client-Secret': '<api-key>'}
};
fetch('https://api.meitner.se/directory/v1/student/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-ID: <api-key>",
"Client-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.meitner.se/directory/v1/student/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-ID", "<api-key>")
req.Header.Add("Client-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.meitner.se/directory/v1/student/{id}")
.header("Client-ID", "<api-key>")
.header("Client-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meitner.se/directory/v1/student/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-ID"] = '<api-key>'
request["Client-Secret"] = '<api-key>'
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": "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"
}
}Get a Student
Retrieves the Student with the given ID.
using Meitner;
using Meitner.Models.Components;
var sdk = new MeitnerSDK(security: new Security() {
Option1 = new SecurityOption1() {
ClientCredentials = "<YOUR_API_KEY_HERE>",
ClientSecret = "<YOUR_API_KEY_HERE>",
},
});
var res = await sdk.Students.GetAsync(id: "123e4567-e89b-12d3-a456-426614174000");
// handle responsefrom 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.get(id="123e4567-e89b-12d3-a456-426614174000")
# Handle response
print(res)curl --request GET \
--url https://api.meitner.se/directory/v1/student/{id} \
--header 'Client-ID: <api-key>' \
--header 'Client-Secret: <api-key>'const options = {
method: 'GET',
headers: {'Client-ID': '<api-key>', 'Client-Secret': '<api-key>'}
};
fetch('https://api.meitner.se/directory/v1/student/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-ID: <api-key>",
"Client-Secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.meitner.se/directory/v1/student/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-ID", "<api-key>")
req.Header.Add("Client-Secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.meitner.se/directory/v1/student/{id}")
.header("Client-ID", "<api-key>")
.header("Client-Secret", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meitner.se/directory/v1/student/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-ID"] = '<api-key>'
request["Client-Secret"] = '<api-key>'
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": "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
Path Parameters
The unique identifier of the Student to retrieve
"123e4567-e89b-12d3-a456-426614174000"
Response
Response for Student Get operation - returns the requested Student
Student holds the personal information about a student, information about the school is stored in the StudentPlacement-resource.
Unique identifier for the Student
"123e4567-e89b-12d3-a456-426614174000"
The identity number of the student in the format YYYYMMDD-NNNN, must be unique within the organization.
"20191216-1234"
The first name of the student
"Lise"
The last name of the student
"Meitner"
Metadata information for the Student
Show child attributes
Show child attributes
{ "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
{ "sourceID": "12345678", "source": "ExternalIntegrationAPI" }
The gender of the student
Female, Male, Other "Female"
If the identity number is temporary for the student
true
The date of birth of the student
"2019-12-16"
null
The address of the student
Show child attributes
Show child attributes
{ "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.
"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.
"lise@gmail.com"
null
The primary phone number of the student, will be used for communication with the student from the system.
"+46701234567"
null
The secondary phone number of the student, will not be used within the system, but will be displayed for contact information.
"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
"kalko@edu.goteborg.se"
null