Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Hanterar data kopplade till elever i eller från Sundsvalls kommun.
Livscykelstatus
Test
Lösningsbeskrivning
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Hantering av personuppgifter
Hanterar personnummer, adresser, namn samt skola för minderåriga.
API specifikation
Hämta elevdata
Exempelanrop:
GET
/student/1.0/pupil/{personalNumber}
Returnerar information om angiven elev.
Personnummer måste anges med 12 siffror.
Svar:
| Code Block | ||
|---|---|---|
| ||
{
"personNumber": "199901011111",
"givenname": "Kim",
"lastname": "Kimsson",
"gender": "K",
"smtpAddress": "kim@edu.sundsvall.se",
"address": "EXEMPELVÄGEN 10 LGH 1001",
"co": "EVENTUELL C/O ADRESS",
"countyMunicipalityCode": "2281",
"postalCode": "855 55",
"city": "SUNDSVALL",
"yearGroup": "3",
"programme": "PROGRAM01",
"scbCode": "12345678",
"unitCode": "SKOLA",
"schoolName": "Sundsvalls gymnasium, Hedbergska",
"pupilGroup": "SA01"
} |
| Expand | ||
|---|---|---|
| ||
Kommer snart |
| Swagger ui |
|---|
openapi: 3.0.1
info:
title: Student
version: '1.0'
servers:
- url: https://api-test.sundsvall.se/student/1.0
paths:
'/pupil/{personalNumber}':
get:
tags:
- Student
parameters:
- name: personalNumber
in: path
required: true
style: simple
explode: false
schema:
type: string
format: string
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Pupil'
application/json:
schema:
$ref: '#/components/schemas/Pupil'
text/json:
schema:
$ref: '#/components/schemas/Pupil'
security:
- ApiKeyAuth: []
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: apikey
schemas:
Pupil:
type: object
properties:
personNumber:
type: string
nullable: true
givenname:
type: string
nullable: true
lastname:
type: string
nullable: true
gender:
type: string
nullable: true
smtpAddress:
type: string
nullable: true
privateMobile:
type: string
nullable: true
homePhone:
type: string
nullable: true
address:
type: string
nullable: true
countyMunicipalityCode:
type: string
nullable: true
postalCode:
type: string
nullable: true
city:
type: string
nullable: true
yearGroup:
type: string
nullable: true
programme:
type: string
nullable: true
scbCode:
type: string
nullable: true
unitCode:
type: string
nullable: true
schoolName:
type: string
nullable: true
pupilGroup:
type: string
nullable: true
additionalProperties: false |
Säkerhetsklassning
Säkerhetsklass 2
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/META
För tekniska frågor: joel.lindberg@sundsvall.se, marcus.olsson@xpservices.se
Länkar
<Länkar till dev-portal;
Test
Sandbox
Produktion>
FAQ
<FAQ>