e-Schooling API
  1. GETTING STARTED
e-Schooling API
  • e-Schooling API
  • GETTING STARTED
    • Authorization
    • Defaults
  • entities
    • Gets all system entities
      GET
    • Gets a entity from its id
      GET
  • students
    • Gets all system students
      GET
    • Gets a student from its id
      GET
  • tutors
    • Gets all system tutors
      GET
    • Gets a tutor from its id
      GET
  • staffs
    • Gets all system staffs
      GET
    • Gets a staff from its id
      GET
  • teachers
    • Gets all system teachers
      GET
    • Gets a teacher from its id
      GET
  • system
    • Obtain tenant informations
      GET
  • sso
    • Single Sign-On
    • Generate OAuth2 Token
      POST
    • Get user info
      GET
  • Schemas
    • Schemas
      • BadRequestHttpException
      • EntitiesAddresses
      • EntitiesContacts
      • EntityBankAccount
      • EntitiesList
      • EntityIdentificationDocument
      • Entity
      • HttpStatusCode
      • InternalServerErrorHttpException
      • MethodBase
      • EntityIdentificationDocumentInsertRequest
      • NotFoundHttpException
      • NoContent
      • EntityInsertRequest
      • OAuthMeResponse
      • OAuthTokenResponse
      • ProblemDetails
      • Staff
      • StaffIdentificationDocumentInsertRequest
      • StaffInsertRequest
      • StaffsList
      • Student
      • StudentIdentificationDocumentInsertRequest
      • StudentInsertRequest
      • StudentsList
      • SystemStatus
      • Teacher
      • TeacherIdentificationDocumentInsertRequest
      • TeacherInsertRequest
      • TeachersList
      • Tutor
      • TutorIdentificationDocumentInsertRequest
      • TutorInsertRequest
      • TutorsList
  1. GETTING STARTED

Defaults

JSON Serialization#

The json default serialization schema is listed in the following table
TypeOpenAPI typeOpenAPI format
intintegerint32
longintegerint64
shortintegerint16
byteintegeruint8
floatnumberfloat
doublenumberdouble
decimalnumberdouble
boolboolean
stringstring
charstringchar
byte[]stringbyte
DateTimeOffsetstring ("yyyy-mm-ddThh:mm:ssZ")date-time
DateOnlystring ("yyyy-mm-ddT")date
TimeOnlystringtime
Uristringuri
Guidstringuuid
Please note that for all date or datetime types the default format is "yyyy-mm-ddT{hh:mm:ss}Z"

Optional Headers#

All endpoints accepts as optional header the Culture and Timezone
The Culture header specifies the culture of string resources (string translations).
Allowed values: pt-PT, pt-BR, en-GB, en-US, it-IT
The Timezone header specifies the timezone applied in dates and times formating (IANA format)
When sent this optional parameter indicates the system to automatically convert any returned datetime to the timezone specified, or convert to utc any posted datetime to the specified timezone
Modified at 2025-04-10 08:41:32
Previous
Authorization
Next
Gets all system entities
Built with