Internal API - Revision history

WordpressAdmin69 at 10:52, 18 May 2019

2019-05-18T10:52:58Z

WordpressAdmin69 at 10:52, 18 May 2019

2019-05-18T10:52:09Z

WordpressAdmin69 at 10:49, 18 May 2019

2019-05-18T10:49:48Z

WordpressAdmin69 at 10:47, 29 March 2019

2019-03-29T10:47:10Z

WordpressAdmin69 at 10:26, 29 March 2019

2019-03-29T10:26:03Z

WordpressAdmin69 at 10:13, 29 March 2019

2019-03-29T10:13:48Z

WordpressAdmin69 at 10:11, 29 March 2019

2019-03-29T10:11:47Z

WordpressAdmin69 at 10:09, 29 March 2019

2019-03-29T10:09:08Z

WordpressAdmin69 at 09:57, 29 March 2019

2019-03-29T09:57:37Z

WordpressAdmin69 at 09:28, 29 March 2019

2019-03-29T09:28:00Z

@@ Line 111: / Line 111: @@
 | /sessions/<identity> || test_taking_user, Delete only for regular_office_user || returns session information. If test_taking_user limited for this test taking user || SessionID, CompanyID, IncludeMaster, IncludeClient  || 200 OK or 404 token invalid || Get, Post, Delete
 |-
-| /sessions/<identity>/groupmembers || regular_office_user  || returns group member information. || ID,EMail,FirstName,Initials,LastName,TitlesBefore,TitlesAfter,EducationID,OrganisationID,NationalityID,PreferredLanguage,Sex,DateOfLastTest,BirthDate,CompanyID,Active,ManagedByUserID  || 200 OK or 404 token invalid || Get, Post, Delete
+| /sessions/<identity>/groupmembers || regular_office_user  || returns group member information. || ID,EMail,FirstName,Initials, LastName,TitlesBefore,TitlesAfter, EducationID,OrganisationID, NationalityID,PreferredLanguage,Sex,DateOfLastTest, BirthDate,CompanyID, Active,ManagedByUserID  || 200 OK or 404 token invalid || Get, Post, Delete
 |-
 | /reportdefinitions/<identity> || regular_office_user || returns reportdefinition information || SessionID, CompanyID, IncludeMaster, IncludeClient  || 200 OK or 404 token invalid || Get, Post, Delete

@@ Line 110: / Line 110: @@
 |-
 | /sessions/<identity> || test_taking_user, Delete only for regular_office_user || returns session information. If test_taking_user limited for this test taking user || SessionID, CompanyID, IncludeMaster, IncludeClient  || 200 OK or 404 token invalid || Get, Post, Delete
 |-
 | /reportdefinitions/<identity> || regular_office_user || returns reportdefinition information || SessionID, CompanyID, IncludeMaster, IncludeClient  || 200 OK or 404 token invalid || Get, Post, Delete

@@ Line 48: / Line 48: @@
 |-
 | sessionsview || regular_office_user || returns sessiontests || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 | sessions || regular_office_user and test_taking_user || returns sessions. for test_taking_user ONLY the sessions of the test taking user are returned. || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get

@@ Line 85: / Line 85: @@
 ! Endpoint !! Role !! Description !! Headers !! Response codes !! Supported operations
 |-
-| /audittrail/<identity> || regular_office_user, Delete only for master_user || returns audit trial || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get, Post, Delete
+| /audittrail/<identity> || regular_office_user, Delete only for master_user || returns audit trial entry information || SessionID, CompanyID, IncludeMaster, IncludeClient  || 200 OK or 404 token invalid || Get, Post, Delete
 |-
 |}

@@ Line 58: / Line 58: @@
 |-
 | creditusages || regular_office_user || returns creditusages || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 | datagathering || regular_office_user || returns datagathering || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get

@@ Line 4: / Line 4: @@
 The following API calls are available for the following roles (in case of doubt check the source code in the application.py file on github):
 {| class="wikitable sortable"
@@ Line 16: / Line 18: @@
 |-
 | login || All || Login endpoint  || UserID, Password, CompanyID (optional) || 200 OK or 401 user not found in case user is unknown or user id/password combination is not correct || Get
 |-
 | sendresetpassword || All || Send a reset password link via mail. The mail contains a URL with a token which is valid for 5 minutes. || UserID || 200 OK or 404 user not found  || Post
@@ Line 73: / Line 74: @@
 |-
 | translations || All || returns available translations || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 |}

@@ Line 40: / Line 40: @@
 | organisations || regular_office_user || returns organisations || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| persons || regular_office_user || returns persons || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| persons || regular_office_user & test_taking_user || returns persons. On post the login is created. For test_taking_user ONLY the DateOfLastTest field can be updated, the rest of the fields is ignored and no login is created. || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| sessiontests || regular_office_user || returns sessiontests || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| sessiontests || regular_office_user || returns sessiontestsview, a combination of sessions, person, and sessiontests || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| sessions || regular_office_user || returns sessions || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| sessiontestsview || regular_office_user || returns sessionsview, a combination of sessions and person || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 | reportdefinitions || regular_office_user || returns reportdefinitions || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| companies || regular_office_user || returns companies || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| companies || master_user || returns companies || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 | creditgrants || regular_office_user || returns creditgrants || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
@@ Line 60: / Line 64: @@
 | logins || regular_office_user || returns logins || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| tokens || regular_office_user || returns tokens || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| tokens || master_user || returns tokens || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| systemsettings || regular_office_user || returns systemsettings || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| systemsettings || regular_office_user || returns systemsettings which are NOT protected. || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| screentemplates || regular_office_user || returns screentemplates || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| screentemplates || test_taking_user || returns screentemplates || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 | tests || regular_office_user || returns tests || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
-| translations || regular_office_user || returns translations || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
+| translations || All || returns available translations || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 |}

@@ Line 28: / Line 28: @@
 | audittrail || regular_office_user || returns audit trial || SessionID, CompanyID, StartPage, PageSize, Sort (optional), IncludeMaster, IncludeClient, SearchField (optional), TimeZoneOffset, Filter (optional)  || 200 OK or 404 token invalid || Get
 |-
 |}