GET OnteAuth

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OnteAuthKey	string	None.
Login	string	None.
Password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OnteAuthKey": "sample string 1",
  "Login": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:

<OnteAuthRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iSAPS.API.Models">
  <Login>sample string 2</Login>
  <OnteAuthKey>sample string 1</OnteAuthKey>
  <Password>sample string 3</Password>
</OnteAuthRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnteAuthResponse

Name	Type	Additional information
AuthStatus	integer	None.
UserId	integer	None.
Student	boolean	None.
Employee	boolean	None.
Teacher	boolean	None.
Candidate	boolean	None.
CkpisCourseStudent	boolean	None.
FirstName	string	None.
LastName	string	None.
Email	string	None.
City	string	None.
OrganizationalUnit1	string	None.
OrganizationalUnit2	string	None.
Album	string	None.
Year	string	None.
Groups	Collection of OnteAuthResponseGroups	None.
RecruitmentCourses	Collection of OnteAuthRecrutCourse	None.
Citizenship	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AuthStatus": 1,
  "UserId": 2,
  "Student": true,
  "Employee": true,
  "Teacher": true,
  "Candidate": true,
  "CkpisCourseStudent": true,
  "FirstName": "sample string 8",
  "LastName": "sample string 9",
  "Email": "sample string 10",
  "City": "sample string 11",
  "OrganizationalUnit1": "sample string 12",
  "OrganizationalUnit2": "sample string 13",
  "Album": "sample string 14",
  "Year": "sample string 15",
  "Groups": [
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "Year": "sample string 3",
      "CurrentSemester": 4,
      "TotalSemesters": 1,
      "State": "sample string 5"
    },
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "Year": "sample string 3",
      "CurrentSemester": 4,
      "TotalSemesters": 1,
      "State": "sample string 5"
    }
  ],
  "RecruitmentCourses": [
    {
      "RecruitmentId": 1,
      "CourseId": 2,
      "CourseName": "sample string 3",
      "AcademicYear": "sample string 4",
      "CohortId": "sample string 5"
    },
    {
      "RecruitmentId": 1,
      "CourseId": 2,
      "CourseName": "sample string 3",
      "AcademicYear": "sample string 4",
      "CohortId": "sample string 5"
    }
  ],
  "Citizenship": 1
}

application/xml, text/xml

Sample:

<OnteAuthResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iSAPS.API.Models">
  <Album>sample string 14</Album>
  <AuthStatus>1</AuthStatus>
  <Candidate>true</Candidate>
  <Citizenship>1</Citizenship>
  <City>sample string 11</City>
  <CkpisCourseStudent>true</CkpisCourseStudent>
  <Email>sample string 10</Email>
  <Employee>true</Employee>
  <FirstName>sample string 8</FirstName>
  <Groups>
    <OnteAuthResponseGroups>
      <CurrentSemester>4</CurrentSemester>
      <GroupId>1</GroupId>
      <GroupName>sample string 2</GroupName>
      <State>sample string 5</State>
      <TotalSemesters>1</TotalSemesters>
      <Year>sample string 3</Year>
    </OnteAuthResponseGroups>
    <OnteAuthResponseGroups>
      <CurrentSemester>4</CurrentSemester>
      <GroupId>1</GroupId>
      <GroupName>sample string 2</GroupName>
      <State>sample string 5</State>
      <TotalSemesters>1</TotalSemesters>
      <Year>sample string 3</Year>
    </OnteAuthResponseGroups>
  </Groups>
  <LastName>sample string 9</LastName>
  <OrganizationalUnit1>sample string 12</OrganizationalUnit1>
  <OrganizationalUnit2>sample string 13</OrganizationalUnit2>
  <RecruitmentCourses>
    <OnteAuthRecrutCourse>
      <AcademicYear>sample string 4</AcademicYear>
      <CohortId>sample string 5</CohortId>
      <CourseId>2</CourseId>
      <CourseName>sample string 3</CourseName>
      <RecruitmentId>1</RecruitmentId>
    </OnteAuthRecrutCourse>
    <OnteAuthRecrutCourse>
      <AcademicYear>sample string 4</AcademicYear>
      <CohortId>sample string 5</CohortId>
      <CourseId>2</CourseId>
      <CourseName>sample string 3</CourseName>
      <RecruitmentId>1</RecruitmentId>
    </OnteAuthRecrutCourse>
  </RecruitmentCourses>
  <Student>true</Student>
  <Teacher>true</Teacher>
  <UserId>2</UserId>
  <Year>sample string 15</Year>
</OnteAuthResponse>