POST Api/Launch/LogOut
Request Information
URI Parameters
None.
Body Parameters
LoginModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Password | string |
None. |
|
| CampusName | string |
None. |
|
| DeviceID | string |
None. |
|
| DeviceOS | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"CampusName": "sample string 3",
"DeviceID": "sample string 4",
"DeviceOS": "sample string 5"
}
text/html
Sample:
{"Username":"sample string 1","Password":"sample string 2","CampusName":"sample string 3","DeviceID":"sample string 4","DeviceOS":"sample string 5"}
application/xml, text/xml
Sample:
<LoginModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model"> <CampusName>sample string 3</CampusName> <DeviceID>sample string 4</DeviceID> <DeviceOS>sample string 5</DeviceOS> <Password>sample string 2</Password> <Username>sample string 1</Username> </LoginModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LoginReturnResult| Name | Description | Type | Additional information |
|---|---|---|---|
| status | boolean |
None. |
|
| message | string |
None. |
|
| UserName | string |
None. |
|
| CampusList | Collection of tblSchSvrDB |
None. |
|
| UserType | string |
None. |
|
| CampusName | string |
None. |
|
| UserID | string |
None. |
|
| AccessToken | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": true,
"message": "sample string 2",
"UserName": "sample string 3",
"CampusList": [
{
"School_Key": 1,
"SchoolName": "sample string 2",
"ServerName": "sample string 3",
"DatabaseName": "sample string 4",
"Lesson_Plan_Type": 1,
"Incident_Type": 1,
"Progress_Type": 1,
"ADE": 1,
"LastDataBase": "sample string 5",
"Version": "sample string 6",
"Server": "sample string 7",
"Default": true,
"Accessed": "2025-05-31T22:13:52.0105143-04:00",
"School_RptSuffix": "sample string 8",
"State": "sample string 9",
"City": "sample string 10",
"Zip": 1,
"Domain": "sample string 11",
"AreaCode": 1,
"LicenseCode": 1.1,
"ASAHID": 1,
"Status": "sample string 12",
"TotalPoints": 1,
"LogDefault": 1,
"LogDuration": 1,
"NotifyUnenrolled": true,
"NotifyOutSuspended": true,
"NotifyInSuspended": true,
"NotifyIEPScheduled": true,
"NotifyIEPDueScheduled": true,
"NotifyIEPDue": true,
"NotifyIEP": true,
"NotifyEnrolled": true,
"NotifyClassroomChange": true,
"NotifyClassChange": true,
"NotifyBirthday": true,
"NotifyAccepted": true,
"School_Timesheet": "sample string 13",
"NotifyAlerts": true,
"flgNeedsGrade": true,
"flgNeedsInHouseSociaWorker": true,
"SpellCheckINIPath": "sample string 14",
"ODBCDriver": "sample string 15",
"ODBCConnection": "sample string 16",
"TimesheetDefaultTimes": true,
"NormalSpineDefault": true,
"Hosted": true,
"JobPlacement": true,
"TurnOffStaffAttendWarnings": true,
"InActive": true,
"ClassHistoryEnabled": true,
"TurnOffStudentAttendLateCheck": true,
"InvoiceStyle": true,
"HighContrast": true,
"ISONAS_Campus": "sample string 17",
"ISONAS_ID_Prefix": "sample string 18",
"LocalPhoneNumber": "sample string 19",
"ISONASUsed": true,
"flgHIPAA": true,
"flgForceLogon": true,
"LogonPrefix": "sample string 20",
"DispMsg": true,
"LastArchive": "2025-05-31T22:13:52.0105143-04:00",
"OpenChoice": "sample string 21",
"StudentInitials": true,
"flgForce2FA": true
},
{
"School_Key": 1,
"SchoolName": "sample string 2",
"ServerName": "sample string 3",
"DatabaseName": "sample string 4",
"Lesson_Plan_Type": 1,
"Incident_Type": 1,
"Progress_Type": 1,
"ADE": 1,
"LastDataBase": "sample string 5",
"Version": "sample string 6",
"Server": "sample string 7",
"Default": true,
"Accessed": "2025-05-31T22:13:52.0105143-04:00",
"School_RptSuffix": "sample string 8",
"State": "sample string 9",
"City": "sample string 10",
"Zip": 1,
"Domain": "sample string 11",
"AreaCode": 1,
"LicenseCode": 1.1,
"ASAHID": 1,
"Status": "sample string 12",
"TotalPoints": 1,
"LogDefault": 1,
"LogDuration": 1,
"NotifyUnenrolled": true,
"NotifyOutSuspended": true,
"NotifyInSuspended": true,
"NotifyIEPScheduled": true,
"NotifyIEPDueScheduled": true,
"NotifyIEPDue": true,
"NotifyIEP": true,
"NotifyEnrolled": true,
"NotifyClassroomChange": true,
"NotifyClassChange": true,
"NotifyBirthday": true,
"NotifyAccepted": true,
"School_Timesheet": "sample string 13",
"NotifyAlerts": true,
"flgNeedsGrade": true,
"flgNeedsInHouseSociaWorker": true,
"SpellCheckINIPath": "sample string 14",
"ODBCDriver": "sample string 15",
"ODBCConnection": "sample string 16",
"TimesheetDefaultTimes": true,
"NormalSpineDefault": true,
"Hosted": true,
"JobPlacement": true,
"TurnOffStaffAttendWarnings": true,
"InActive": true,
"ClassHistoryEnabled": true,
"TurnOffStudentAttendLateCheck": true,
"InvoiceStyle": true,
"HighContrast": true,
"ISONAS_Campus": "sample string 17",
"ISONAS_ID_Prefix": "sample string 18",
"LocalPhoneNumber": "sample string 19",
"ISONASUsed": true,
"flgHIPAA": true,
"flgForceLogon": true,
"LogonPrefix": "sample string 20",
"DispMsg": true,
"LastArchive": "2025-05-31T22:13:52.0105143-04:00",
"OpenChoice": "sample string 21",
"StudentInitials": true,
"flgForce2FA": true
}
],
"UserType": "sample string 4",
"CampusName": "sample string 5",
"UserID": "sample string 6",
"AccessToken": "a4768b1a-b5c1-4561-86e7-324b8a368354"
}
text/html
Sample:
{"status":true,"message":"sample string 2","UserName":"sample string 3","CampusList":[{"School_Key":1,"SchoolName":"sample string 2","ServerName":"sample string 3","DatabaseName":"sample string 4","Lesson_Plan_Type":1,"Incident_Type":1,"Progress_Type":1,"ADE":1,"LastDataBase":"sample string 5","Version":"sample string 6","Server":"sample string 7","Default":true,"Accessed":"2025-05-31T22:13:52.0105143-04:00","School_RptSuffix":"sample string 8","State":"sample string 9","City":"sample string 10","Zip":1,"Domain":"sample string 11","AreaCode":1,"LicenseCode":1.1,"ASAHID":1,"Status":"sample string 12","TotalPoints":1,"LogDefault":1,"LogDuration":1,"NotifyUnenrolled":true,"NotifyOutSuspended":true,"NotifyInSuspended":true,"NotifyIEPScheduled":true,"NotifyIEPDueScheduled":true,"NotifyIEPDue":true,"NotifyIEP":true,"NotifyEnrolled":true,"NotifyClassroomChange":true,"NotifyClassChange":true,"NotifyBirthday":true,"NotifyAccepted":true,"School_Timesheet":"sample string 13","NotifyAlerts":true,"flgNeedsGrade":true,"flgNeedsInHouseSociaWorker":true,"SpellCheckINIPath":"sample string 14","ODBCDriver":"sample string 15","ODBCConnection":"sample string 16","TimesheetDefaultTimes":true,"NormalSpineDefault":true,"Hosted":true,"JobPlacement":true,"TurnOffStaffAttendWarnings":true,"InActive":true,"ClassHistoryEnabled":true,"TurnOffStudentAttendLateCheck":true,"InvoiceStyle":true,"HighContrast":true,"ISONAS_Campus":"sample string 17","ISONAS_ID_Prefix":"sample string 18","LocalPhoneNumber":"sample string 19","ISONASUsed":true,"flgHIPAA":true,"flgForceLogon":true,"LogonPrefix":"sample string 20","DispMsg":true,"LastArchive":"2025-05-31T22:13:52.0105143-04:00","OpenChoice":"sample string 21","StudentInitials":true,"flgForce2FA":true},{"School_Key":1,"SchoolName":"sample string 2","ServerName":"sample string 3","DatabaseName":"sample string 4","Lesson_Plan_Type":1,"Incident_Type":1,"Progress_Type":1,"ADE":1,"LastDataBase":"sample string 5","Version":"sample string 6","Server":"sample string 7","Default":true,"Accessed":"2025-05-31T22:13:52.0105143-04:00","School_RptSuffix":"sample string 8","State":"sample string 9","City":"sample string 10","Zip":1,"Domain":"sample string 11","AreaCode":1,"LicenseCode":1.1,"ASAHID":1,"Status":"sample string 12","TotalPoints":1,"LogDefault":1,"LogDuration":1,"NotifyUnenrolled":true,"NotifyOutSuspended":true,"NotifyInSuspended":true,"NotifyIEPScheduled":true,"NotifyIEPDueScheduled":true,"NotifyIEPDue":true,"NotifyIEP":true,"NotifyEnrolled":true,"NotifyClassroomChange":true,"NotifyClassChange":true,"NotifyBirthday":true,"NotifyAccepted":true,"School_Timesheet":"sample string 13","NotifyAlerts":true,"flgNeedsGrade":true,"flgNeedsInHouseSociaWorker":true,"SpellCheckINIPath":"sample string 14","ODBCDriver":"sample string 15","ODBCConnection":"sample string 16","TimesheetDefaultTimes":true,"NormalSpineDefault":true,"Hosted":true,"JobPlacement":true,"TurnOffStaffAttendWarnings":true,"InActive":true,"ClassHistoryEnabled":true,"TurnOffStudentAttendLateCheck":true,"InvoiceStyle":true,"HighContrast":true,"ISONAS_Campus":"sample string 17","ISONAS_ID_Prefix":"sample string 18","LocalPhoneNumber":"sample string 19","ISONASUsed":true,"flgHIPAA":true,"flgForceLogon":true,"LogonPrefix":"sample string 20","DispMsg":true,"LastArchive":"2025-05-31T22:13:52.0105143-04:00","OpenChoice":"sample string 21","StudentInitials":true,"flgForce2FA":true}],"UserType":"sample string 4","CampusName":"sample string 5","UserID":"sample string 6","AccessToken":"a4768b1a-b5c1-4561-86e7-324b8a368354"}
application/xml, text/xml
Sample:
<LoginReturnResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParadigmPioneer.Core.Model.PPIHX">
<CampusList>
<tblSchSvrDB>
<ADE>1</ADE>
<ASAHID>1</ASAHID>
<Accessed>2025-05-31T22:13:52.0105143-04:00</Accessed>
<AreaCode>1</AreaCode>
<City>sample string 10</City>
<ClassHistoryEnabled>true</ClassHistoryEnabled>
<DatabaseName>sample string 4</DatabaseName>
<Default>true</Default>
<DispMsg>true</DispMsg>
<Domain>sample string 11</Domain>
<HighContrast>true</HighContrast>
<Hosted>true</Hosted>
<ISONASUsed>true</ISONASUsed>
<ISONAS_Campus>sample string 17</ISONAS_Campus>
<ISONAS_ID_Prefix>sample string 18</ISONAS_ID_Prefix>
<InActive>true</InActive>
<Incident_Type>1</Incident_Type>
<InvoiceStyle>true</InvoiceStyle>
<JobPlacement>true</JobPlacement>
<LastArchive>2025-05-31T22:13:52.0105143-04:00</LastArchive>
<LastDataBase>sample string 5</LastDataBase>
<Lesson_Plan_Type>1</Lesson_Plan_Type>
<LicenseCode>1.1</LicenseCode>
<LocalPhoneNumber>sample string 19</LocalPhoneNumber>
<LogDefault>1</LogDefault>
<LogDuration>1</LogDuration>
<LogonPrefix>sample string 20</LogonPrefix>
<NormalSpineDefault>true</NormalSpineDefault>
<NotifyAccepted>true</NotifyAccepted>
<NotifyAlerts>true</NotifyAlerts>
<NotifyBirthday>true</NotifyBirthday>
<NotifyClassChange>true</NotifyClassChange>
<NotifyClassroomChange>true</NotifyClassroomChange>
<NotifyEnrolled>true</NotifyEnrolled>
<NotifyIEP>true</NotifyIEP>
<NotifyIEPDue>true</NotifyIEPDue>
<NotifyIEPDueScheduled>true</NotifyIEPDueScheduled>
<NotifyIEPScheduled>true</NotifyIEPScheduled>
<NotifyInSuspended>true</NotifyInSuspended>
<NotifyOutSuspended>true</NotifyOutSuspended>
<NotifyUnenrolled>true</NotifyUnenrolled>
<ODBCConnection>sample string 16</ODBCConnection>
<ODBCDriver>sample string 15</ODBCDriver>
<OpenChoice>sample string 21</OpenChoice>
<Progress_Type>1</Progress_Type>
<SchoolName>sample string 2</SchoolName>
<School_Key>1</School_Key>
<School_RptSuffix>sample string 8</School_RptSuffix>
<School_Timesheet>sample string 13</School_Timesheet>
<Server>sample string 7</Server>
<ServerName>sample string 3</ServerName>
<SpellCheckINIPath>sample string 14</SpellCheckINIPath>
<State>sample string 9</State>
<Status>sample string 12</Status>
<StudentInitials>true</StudentInitials>
<TimesheetDefaultTimes>true</TimesheetDefaultTimes>
<TotalPoints>1</TotalPoints>
<TurnOffStaffAttendWarnings>true</TurnOffStaffAttendWarnings>
<TurnOffStudentAttendLateCheck>true</TurnOffStudentAttendLateCheck>
<Version>sample string 6</Version>
<Zip>1</Zip>
<flgForce2FA>true</flgForce2FA>
<flgForceLogon>true</flgForceLogon>
<flgHIPAA>true</flgHIPAA>
<flgNeedsGrade>true</flgNeedsGrade>
<flgNeedsInHouseSociaWorker>true</flgNeedsInHouseSociaWorker>
</tblSchSvrDB>
<tblSchSvrDB>
<ADE>1</ADE>
<ASAHID>1</ASAHID>
<Accessed>2025-05-31T22:13:52.0105143-04:00</Accessed>
<AreaCode>1</AreaCode>
<City>sample string 10</City>
<ClassHistoryEnabled>true</ClassHistoryEnabled>
<DatabaseName>sample string 4</DatabaseName>
<Default>true</Default>
<DispMsg>true</DispMsg>
<Domain>sample string 11</Domain>
<HighContrast>true</HighContrast>
<Hosted>true</Hosted>
<ISONASUsed>true</ISONASUsed>
<ISONAS_Campus>sample string 17</ISONAS_Campus>
<ISONAS_ID_Prefix>sample string 18</ISONAS_ID_Prefix>
<InActive>true</InActive>
<Incident_Type>1</Incident_Type>
<InvoiceStyle>true</InvoiceStyle>
<JobPlacement>true</JobPlacement>
<LastArchive>2025-05-31T22:13:52.0105143-04:00</LastArchive>
<LastDataBase>sample string 5</LastDataBase>
<Lesson_Plan_Type>1</Lesson_Plan_Type>
<LicenseCode>1.1</LicenseCode>
<LocalPhoneNumber>sample string 19</LocalPhoneNumber>
<LogDefault>1</LogDefault>
<LogDuration>1</LogDuration>
<LogonPrefix>sample string 20</LogonPrefix>
<NormalSpineDefault>true</NormalSpineDefault>
<NotifyAccepted>true</NotifyAccepted>
<NotifyAlerts>true</NotifyAlerts>
<NotifyBirthday>true</NotifyBirthday>
<NotifyClassChange>true</NotifyClassChange>
<NotifyClassroomChange>true</NotifyClassroomChange>
<NotifyEnrolled>true</NotifyEnrolled>
<NotifyIEP>true</NotifyIEP>
<NotifyIEPDue>true</NotifyIEPDue>
<NotifyIEPDueScheduled>true</NotifyIEPDueScheduled>
<NotifyIEPScheduled>true</NotifyIEPScheduled>
<NotifyInSuspended>true</NotifyInSuspended>
<NotifyOutSuspended>true</NotifyOutSuspended>
<NotifyUnenrolled>true</NotifyUnenrolled>
<ODBCConnection>sample string 16</ODBCConnection>
<ODBCDriver>sample string 15</ODBCDriver>
<OpenChoice>sample string 21</OpenChoice>
<Progress_Type>1</Progress_Type>
<SchoolName>sample string 2</SchoolName>
<School_Key>1</School_Key>
<School_RptSuffix>sample string 8</School_RptSuffix>
<School_Timesheet>sample string 13</School_Timesheet>
<Server>sample string 7</Server>
<ServerName>sample string 3</ServerName>
<SpellCheckINIPath>sample string 14</SpellCheckINIPath>
<State>sample string 9</State>
<Status>sample string 12</Status>
<StudentInitials>true</StudentInitials>
<TimesheetDefaultTimes>true</TimesheetDefaultTimes>
<TotalPoints>1</TotalPoints>
<TurnOffStaffAttendWarnings>true</TurnOffStaffAttendWarnings>
<TurnOffStudentAttendLateCheck>true</TurnOffStudentAttendLateCheck>
<Version>sample string 6</Version>
<Zip>1</Zip>
<flgForce2FA>true</flgForce2FA>
<flgForceLogon>true</flgForceLogon>
<flgHIPAA>true</flgHIPAA>
<flgNeedsGrade>true</flgNeedsGrade>
<flgNeedsInHouseSociaWorker>true</flgNeedsInHouseSociaWorker>
</tblSchSvrDB>
</CampusList>
<CampusName>sample string 5</CampusName>
<UserID>sample string 6</UserID>
<UserName>sample string 3</UserName>
<UserType>sample string 4</UserType>
<message>sample string 2</message>
<status>true</status>
</LoginReturnResult>