Alan referansı

Her iki aktarım uç noktasının da kabul ettiği kullanıcı alanları, kayıt (enrollment) nesnesi ve geçerlilik kuralları.

Ortak kullanıcı alanları

Her iki uç noktada da aynıdır.

Aktarım isteğinin kullanıcı alanları
Alan	Tip	Zorunlu	Açıklama
firstName	string	Evet	Ad
lastName	string	Evet	Soyad
identityNumber	string	Koşullu	T.C. kimlik numarası
dateOfBirth	long	Koşullu	Doğum tarihi, epoch milisaniye
phoneNumber	string	Koşullu	Telefon
email	string	Koşullu	E-posta
username	string	Hayır	Gönderilmezse ad-soyaddan üretilir
gender	enum	Hayır	MALE · FEMALE · NOT_GIVEN

Kullanıcı eşleştirme kuralı

Daha önce aktarılmış bir kullanıcıyı yeniden bulabilmek için aşağıdakilerden en az biri gönderilmelidir:

identityNumber, veya
email, veya
dateOfBirth ve phoneNumber (ikisi birlikte)

Hiçbiri yoksa istek provideIdentityNumberEmailOrDateOfBirthAndPhoneNumber hatası ile reddedilir.

identityNumber olarak 11111111111 göndermeyin

Bu değer sistemde "kimlik numarası yok" anlamına gelen yer tutucudur ve eşleştirmede yok sayılır. Kimlik numarası bilinmeyen öğrenciler için bu alanı hiç göndermeyin; yerine dateOfBirth + phoneNumber ikilisini kullanın.

Boş string yerine null gönderin

"email": "" veya "phoneNumber": "" göndermek hataya yol açar. Bilgi yoksa alanı ya hiç göndermeyin ya da null gönderin.

En güvenli yaklaşım: her öğrenci için kalıcı ve değişmeyen bir alan (T.C. kimlik numarası) göndermek. Böylece öğrencinin adı, e-postası veya şubesi değişse dahi aynı kullanıcı bulunur ve mükerrer kayıt oluşmaz.

Kayıt (enrollment) nesnesi

enrollmentList içindeki her nesne bir kaydı temsil eder.

Kayıt alanlarının role göre zorunluluğu
Alan	Tip	Öğrenci	Öğretmen	Yönetici
seasonId	long	Zorunlu	Zorunlu	Zorunlu
gradeName	string	Zorunlu	Zorunlu	Gönderilmemeli
gradeLevel	int	Zorunlu	Zorunlu	Gönderilmemeli
branchName	string	Zorunlu	Zorunlu	Gönderilmemeli
curriculumType	enum	Zorunlu	Zorunlu	Kullanılmaz
coterieType	enum	Opsiyonel	Gönderilmeli (branş)	Zorunlu
staffMode	enum	Yok sayılır	TEACHER (veya boş)	MANAGER
identifier	string	Opsiyonel	Opsiyonel	Opsiyonel

curriculumType: MEB · AP · IB

coterieType: MATHEMATICS · TURKISH · SCIENCE · SOCIAL_STUDIES · LIFE_STUDIES · ENGLISH · GERMAN · FOREIGN_LANGUAGE · LITERATURE · HISTORY · GEOGRAPHY · PHILOSOPHY · PHYSICS · CHEMISTRY · BIOLOGY · ARTS · DESIGN · INFORMATION_TECHNOLOGY · PHYSICAL_EDUCATION · CULTURE_AND_RELIGION_KNOWLEDGE · TRAFFIC_SAFETY · GENERAL_CULTURE · MANAGEMENT

identifier: Sizin sistemdeki kayıt numarası. Zorunlu değildir ancak göndermenizi öneririz — bir kaydın sonradan güncellendiğini anlamamızı sağlar.

gradeLevel sınırları

Sezonun bağlı olduğu kurum tipine göre kabul edilen sınıf seviyeleri:

Kurum tipine göre geçerli sınıf seviyeleri
Kurum tipi	Geçerli gradeLevel
HIGH_SCHOOL (lise)	9 – 12
EAST_SECONDARY (ortaokul)	5 – 8
WEST_PRIMARY	1 – 8
EAST_PRIMARY	1 – 4

Aralık dışındaki değer invalidGradeLevel hatası döner. Yukarıda listelenmeyen kurum tipleri (COLLEGE, COURSE, PRIVATE_TRAINING, COMPANY, ORGANIZATION, PRIVATE_LESSON) için hiçbir sınıf seviyesi kabul edilmez; bu tiplerdeki kurumlara bu uç noktalarla aktarım yapılamaz.

coterieType ile gradeLevel uyumu

Bazı branşlar yalnızca belirli seviyelerde geçerlidir:

gradeLevel 9 ve üzeri ise: SCIENCE, SOCIAL_STUDIES, LIFE_STUDIES gönderilemez.
gradeLevel 9'dan küçük ise: LITERATURE, HISTORY, GEOGRAPHY, PHILOSOPHY, PHYSICS, CHEMISTRY, BIOLOGY gönderilemez.

Uyumsuz kombinasyon invalidCoterieGradeLevelMatch hatası döner.

Sınıf ve şube otomatik oluşturulur

Gönderdiğiniz gradeLevel + curriculumType ikilisine ait sınıf yoksa otomatik oluşturulur; branchName ile eşleşen şube yoksa o da oluşturulur. Yani yeni bir şube açmak için ayrı bir işlem gerekmez.

gradeName mevcut sınıfın adını değiştirir

Aynı gradeLevel + curriculumType için daha önce farklı bir gradeName kaydedilmişse, gönderdiğiniz değer mevcut adı günceller ve bu değişiklik o sınıfı gören tüm kullanıcıları etkiler. gradeName alanını tutarlı gönderin; yazım hatası kurum genelinde sınıf adını değiştirir.