{ "openapi": "3.0.1", "info": { "title": "Biblingo.Core.API", "version": "v1" }, "paths": { "/achievementBadge/getNewlyEarnedBadges": { "get": { "tags": [ "AchievementBadge" ], "summary": "Gets all newly earned (not yet seen by user) achievement badges", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetNewlyEarnedBadgesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetNewlyEarnedBadgesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNewlyEarnedBadgesResponseBiblingoAPIResponse" } } } } } } }, "/achievementBadge/getAll": { "get": { "tags": [ "AchievementBadge" ], "summary": "Gets all achievement badges and statuses for the active user", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetAllBadgesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetAllBadgesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetAllBadgesResponseBiblingoAPIResponse" } } } } } } }, "/AchievementBadge/uploadBadges": { "post": { "tags": [ "AchievementBadge" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/AchievementBadge/uploadMajorBadges": { "post": { "tags": [ "AchievementBadge" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/application/logs/{take}": { "get": { "tags": [ "Application" ], "summary": "Gets the logs from application.", "parameters": [ { "name": "take", "in": "path", "description": "The take value.", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FileResultIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FileResultIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FileResultIEnumerableBiblingoAPIResponse" } } } } } } }, "/user/profile": { "get": { "tags": [ "ApplicationUser" ], "summary": "Gets the profile of a user", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProfileResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProfileResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProfileResponseBiblingoAPIResponse" } } } } } } }, "/user/languages": { "get": { "tags": [ "ApplicationUser" ], "summary": "Gets the subscribed languages of a user", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLanguagesResponseListBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLanguagesResponseListBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLanguagesResponseListBiblingoAPIResponse" } } } } } } }, "/user/verify/{email}": { "get": { "tags": [ "ApplicationUser" ], "summary": "Verifies if an email exists or not for an application user", "parameters": [ { "name": "email", "in": "path", "description": "The email to verify", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyEmailExistsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailExistsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailExistsResponseBiblingoAPIResponse" } } } } } } }, "/token/validate/{id}/{token}": { "get": { "tags": [ "ApplicationUser" ], "summary": "Validate password change request token.", "parameters": [ { "name": "id", "in": "path", "description": "The rowId corresponding to the reset password token.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "" } }, { "name": "token", "in": "path", "description": "The Reset Password Token.", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/token/refresh": { "get": { "tags": [ "ApplicationUser" ], "summary": "Gets the token and app user info after auth refresh.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "408": { "description": "Request Timeout", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/token": { "post": { "tags": [ "ApplicationUser" ], "summary": "Gets the token and app user info after user authentication.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "408": { "description": "Request Timeout", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/client/token": { "post": { "tags": [ "ApplicationUser" ], "summary": "Gets the token and app user info client authentication.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateUserResponseBiblingoAPIResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "408": { "description": "Request Timeout", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/campusedu/token": { "post": { "tags": [ "ApplicationUser" ], "summary": "Gets the token after campus EDU user authentication.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampusEduTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampusEduTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampusEduTokenRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CampusEduTokenRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } } } } } } }, "/fuller/token": { "post": { "tags": [ "ApplicationUser" ], "summary": "Gets the token after Fuller user authentication.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateFullerUserResponseBiblingoAPIResponse" } } } } } } }, "/campusedu/auth/status": { "post": { "tags": [ "ApplicationUser" ], "summary": "Gets the token information after campus EDU user authentication.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponseBiblingoAPIResponse" } } } } } } }, "/user/signup": { "post": { "tags": [ "ApplicationUser" ], "summary": "Sign up process", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignUpUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SignUpUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SignUpUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SignUpUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/user/signup/free": { "post": { "tags": [ "ApplicationUser" ], "summary": "The free sign up async.", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "form": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringValuesKeyValuePair" } } } }, "encoding": { "form": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/user/createupdatesubscription": { "post": { "tags": [ "ApplicationUser" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUpdateSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateSubscriptionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUpdateSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/user/setinitialpassword": { "put": { "tags": [ "ApplicationUser" ], "summary": "Set initial password of a user. Not used for accounts with temp initial password.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetInitialPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetInitialPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetInitialPasswordRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetInitialPasswordRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/user/forgotpassword": { "put": { "tags": [ "ApplicationUser" ], "summary": "Forgot password of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ForgotPasswordResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordResponseBiblingoAPIResponse" } } } } } } }, "/user/resetpassword": { "put": { "tags": [ "ApplicationUser" ], "summary": "Reset password of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "412": { "description": "Client Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "417": { "description": "Client Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } }, "418": { "description": "Client Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/user/changepassword": { "put": { "tags": [ "ApplicationUser" ], "summary": "Change password of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/user/changeemail": { "put": { "tags": [ "ApplicationUser" ], "summary": "Change e-mail of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeEmailRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/user/status": { "put": { "tags": [ "ApplicationUser" ], "summary": "Change status of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeStatusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeStatusRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeStatusRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/user/updatelanguage": { "put": { "tags": [ "ApplicationUser" ], "summary": "Update language of a user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLanguageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLanguageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLanguageRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLanguageRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/assets/map": { "put": { "tags": [ "Asset" ], "summary": "Map assets.", "parameters": [ { "name": "FileType", "in": "query", "schema": { "type": "string" } }, { "name": "IsBackgroundProcess", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/avatar/all": { "get": { "tags": [ "Avatar" ], "summary": "Get all Avatars.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/bible/testaments": { "get": { "tags": [ "Bible" ], "summary": "Gets the Testament.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTestamentResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTestamentResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTestamentResponseBiblingoAPIResponse" } } } } } } }, "/bible/books": { "get": { "tags": [ "Bible" ], "summary": "Gets the Books.", "parameters": [ { "name": "Testament", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBooksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBooksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBooksResponseBiblingoAPIResponse" } } } } } } }, "/bible/chapters": { "get": { "tags": [ "Bible" ], "summary": "Gets the chapters.", "parameters": [ { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChaptersResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChaptersResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChaptersResponseBiblingoAPIResponse" } } } } } } }, "/bible/verses": { "get": { "tags": [ "Bible" ], "summary": "Gets the verses.", "parameters": [ { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Chapter", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetVersesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetVersesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetVersesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/bible/word/senses": { "get": { "tags": [ "Bible" ], "summary": "Gets word sense details", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/word/occurrences": { "get": { "tags": [ "Bible" ], "summary": "Gets The Word Occurrence.", "parameters": [ { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWordOccurrencesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWordOccurrencesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWordOccurrencesResponseBiblingoAPIResponse" } } } } } } }, "/bible/word/frequencies": { "get": { "tags": [ "Bible" ], "summary": "The get word frequencies asynchronous.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWordFrequenciesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWordFrequenciesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWordFrequenciesResponseBiblingoAPIResponse" } } } } } } }, "/bible/recent": { "get": { "tags": [ "Bible" ], "summary": "Gets the recent book.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "ReferenceOnly", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRecentBookResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRecentBookResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRecentBookResponseBiblingoAPIResponse" } } } } } } }, "/bible/book/percentage": { "get": { "tags": [ "Bible" ], "summary": "Gets the Books Wise Percentage.", "parameters": [ { "name": "Testament", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBookWisePercentageResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBookWisePercentageResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBookWisePercentageResponseBiblingoAPIResponse" } } } } } } }, "/bible/chapter/percentage": { "get": { "tags": [ "Bible" ], "summary": "Gets the Chapter Wise Percentage.", "parameters": [ { "name": "Testament", "in": "query", "schema": { "type": "string" } }, { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChapterWisePercentageResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChapterWisePercentageResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChapterWisePercentageResponseBiblingoAPIResponse" } } } } } } }, "/bible/search": { "get": { "tags": [ "Bible" ], "summary": "Search", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchParamType", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/words": { "get": { "tags": [ "Bible" ], "summary": "Search Words", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/verse/reference": { "get": { "tags": [ "Bible" ], "summary": "The get reference async.", "parameters": [ { "name": "Example", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/uploadbook": { "post": { "tags": [ "Bible" ], "summary": "Uploads the book asynchronous.", "parameters": [ { "name": "id", "in": "query", "description": "The identifier.", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadBookResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadBookResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadBookResponseBiblingoAPIResponse" } } } } } } }, "/bible/sense/archive": { "put": { "tags": [ "Bible" ], "summary": "Archive a sense.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/bible/sense/archiveall": { "put": { "tags": [ "Bible" ], "summary": "Archive all senses.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/bible/sense/bulkarchive": { "put": { "tags": [ "Bible" ], "summary": "Bulk archive all senses.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Frequency", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/verses/markasread": { "put": { "tags": [ "Bible" ], "summary": "Mark bible verses as read.", "parameters": [ { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Chapter", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromVerse", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToVerse", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/verses/markasunread": { "put": { "tags": [ "Bible" ], "summary": "Mark bible verses as unread.", "parameters": [ { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Chapter", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromVerse", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToVerse", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/bible/sense/unarchive": { "delete": { "tags": [ "Bible" ], "summary": "Unarchived a sense.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/bible/sense/unarchiveall": { "delete": { "tags": [ "Bible" ], "summary": "Un Archive all senses.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/bibleaudio/map": { "post": { "tags": [ "BibleAudio" ], "summary": "Map bible audio files.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/cache/clearvocab": { "delete": { "tags": [ "Cache" ], "summary": "Map assets.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/cache/clearbible": { "delete": { "tags": [ "Cache" ], "summary": "Map assets.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/getforstudent": { "get": { "tags": [ "ClassRoom" ], "summary": "The Get For Students Async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/classroom/getforteacher": { "get": { "tags": [ "ClassRoom" ], "summary": "The Get For Teachers Async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/classroom/roster": { "get": { "tags": [ "ClassRoom" ], "summary": "Gets the class room roster (owner or active co-teacher only).", "parameters": [ { "name": "ClassRoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Skip", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Take", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "WeekStart", "in": "query", "schema": { "type": "string" } }, { "name": "Period", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetClassRoomRosterResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetClassRoomRosterResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetClassRoomRosterResponseBiblingoAPIResponse" } } } } } } }, "/classroom/create": { "post": { "tags": [ "ClassRoom" ], "summary": "Create Class Room", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClassRoomRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateClassRoomRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateClassRoomRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateClassRoomRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/edit": { "put": { "tags": [ "ClassRoom" ], "summary": "Edit class room", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditClassRoomRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditClassRoomRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditClassRoomRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditClassRoomRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/regeneratecode": { "post": { "tags": [ "ClassRoom" ], "summary": "Regenerates the class room join code (owner or active co-teacher).\r\nThe previous code stops resolving immediately.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegenerateClassRoomCodeResponseBiblingoAPIResponse" } } } } } } }, "/classroom/archive": { "post": { "tags": [ "ClassRoom" ], "summary": "Archives the class room (owner only). History is kept; teacher visibility ends\r\nand the join code stops resolving.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveClassRoomRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArchiveClassRoomRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArchiveClassRoomRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ArchiveClassRoomRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/coteacher/add": { "post": { "tags": [ "ClassRoom" ], "summary": "Adds a co-teacher by email (owner only). Creates a pending placeholder that links\r\non signup/login when no account exists for the email.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCoTeacherRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCoTeacherRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCoTeacherRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCoTeacherRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/coteacher/list": { "get": { "tags": [ "ClassRoom" ], "summary": "Lists a class room's co-teachers (owner or active co-teacher). Each row carries the\r\nmembership id that {classroom/coteacher/remove} takes; the class owner is\r\nreturned separately and is not removable.", "parameters": [ { "name": "ClassRoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetClassRoomCoTeachersResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetClassRoomCoTeachersResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetClassRoomCoTeachersResponseBiblingoAPIResponse" } } } } } } }, "/classroom/coteacher/remove": { "delete": { "tags": [ "ClassRoom" ], "summary": "Removes a co-teacher membership (owner only).", "parameters": [ { "name": "id", "in": "query", "description": "Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/addstudent": { "post": { "tags": [ "ClassRoom" ], "summary": "Adds students to a class by email in bulk (owner or active co-teacher). Each email\r\nbecomes a pending enrolment request the student must accept; unknown emails are\r\nrequested on signup. No invite email is sent and no names are stored.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddClassRoomStudentResponseBiblingoAPIResponse" } } } } } } }, "/classroom/addstudent/preview": { "post": { "tags": [ "ClassRoom" ], "summary": "Previews a bulk add-students email list (owner or active co-teacher): classifies each\r\nemail without creating anything, so the teacher can review before sending requests.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviewAddStudentsResponseBiblingoAPIResponse" } } } } } } }, "/classroom/importstudents": { "post": { "tags": [ "ClassRoom" ], "summary": "Imports students from a CSV roster file (owner or active co-teacher).\r\nColumns: email, language. Rows are processed independently; the response\r\nsummarizes created, linked, skipped and per-row errors.", "parameters": [ { "name": "classRoomId", "in": "query", "description": "Class room Id", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ImportClassRoomStudentsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportClassRoomStudentsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ImportClassRoomStudentsResponseBiblingoAPIResponse" } } } } } } }, "/classroom/join": { "post": { "tags": [ "ClassRoom" ], "summary": "Joins the current user to a class room by join code.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JoinClassRoomByCodeResponseBiblingoAPIResponse" } } } } } } }, "/classroom/leave": { "delete": { "tags": [ "ClassRoom" ], "summary": "Removes the current user from a class room.", "parameters": [ { "name": "classRoomId", "in": "query", "description": "Class room Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/removestudent": { "delete": { "tags": [ "ClassRoom" ], "summary": "Removes a student membership from a class room (owner or active co-teacher).\r\nHistory is kept: the membership is marked Removed rather than deleted.", "parameters": [ { "name": "membershipId", "in": "query", "description": "Membership Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/pendingrequests": { "get": { "tags": [ "ClassRoom" ], "summary": "Lists the current user's pending class enrolment requests (teacher invites awaiting the\r\nstudent's accept/ignore), optionally filtered to the selected language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PendingClassRequestResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PendingClassRequestResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PendingClassRequestResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/classroom/acceptrequest": { "post": { "tags": [ "ClassRoom" ], "summary": "Accepts a pending class enrolment request, choosing whether to share progress with classmates.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptClassRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptClassRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcceptClassRequestRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcceptClassRequestRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/classmates": { "get": { "tags": [ "ClassRoom" ], "summary": "Gets the classmate roster shown on the class-detail screen (opted-in classmates, plus\r\nthe caller's own card and the sharing counts). Members only.", "parameters": [ { "name": "ClassRoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetClassmatesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetClassmatesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetClassmatesResponseBiblingoAPIResponse" } } } } } } }, "/classroom/shareprogress": { "post": { "tags": [ "ClassRoom" ], "summary": "Sets whether the current student shares their progress with classmates in a class.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetShareProgressRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetShareProgressRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetShareProgressRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetShareProgressRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/declinerequest": { "post": { "tags": [ "ClassRoom" ], "summary": "Declines a pending class enrolment request. The request is removed from both the\r\nstudent's and the teacher's view; the teacher can re-invite by email.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineClassRequestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeclineClassRequestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeclineClassRequestRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeclineClassRequestRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/mapstudent": { "put": { "tags": [ "ClassRoom" ], "summary": "Map Student To Class Room", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapStudentToClassRoomRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MapStudentToClassRoomRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MapStudentToClassRoomRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MapStudentToClassRoomRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/delete": { "delete": { "tags": [ "ClassRoom" ], "summary": "Delete Class Room.", "parameters": [ { "name": "id", "in": "query", "description": "Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/classroom/deleteforstudent": { "delete": { "tags": [ "ClassRoom" ], "summary": "Delete Class Room Student.", "parameters": [ { "name": "id", "in": "query", "description": "Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/streak": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets the current and longest streak of a Students", "parameters": [ { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveStreakResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveStreakResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveStreakResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityoverview/daysspent": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get days spent overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityoverview/pointsaccumulated": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get points accumulated overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectivePointAccumulatedOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointAccumulatedOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointAccumulatedOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityoverview/numberofsession": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get session overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityoverview/timespent": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get time spent overview", "parameters": [ { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityroundchart/daysspentbybiblereading": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Days Spent chart by bible reading", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByBibleReadingResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByBibleReadingResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByBibleReadingResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityroundchart/daysspentbyflashcard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Days Spent chart by flash card", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByFlashCardResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByFlashCardResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByFlashCardResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activityroundchart/daysspentbylanguagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Days Spent chart by language learning", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByLanguageLearningResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByLanguageLearningResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByLanguageLearningResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/points/biblereading": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Points accumulated chart by bible reading", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/points/flashcard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Points accumulated chart by flash card", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/points/languagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Points accumulated chart by Language Learning", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectivePointChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/sessions/biblereading": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Number Of Session chart by bible reading", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByBibleReadingResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/sessions/flashcard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Number Of Session chart by flash card", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByFlashCardResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/sessions/languagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Number of sessions chart by Language Learning", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSessionByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/learningtime/biblereading": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Time spent chart by bible reading", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByBibleReadingResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/learningtime/flashcard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Time spent chart by flash card", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByFlashCardResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/activitylinechart/learningtime/languagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Time spent chart by Language Learning", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularyoverview/numberofwordslearned": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets number of words learned Overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularyoverview/proficiency": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets vocabulary proficiency Overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveVocabProficiencyOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveVocabProficiencyOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveVocabProficiencyOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularylinechart/numberofwordslearned/biblereading": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets words learned line chart by bible reading", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByBibleReadingResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByBibleReadingResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularylinechart/numberofwordslearned/flashcard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets words learned line chart by flash card", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByFlashCardResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByFlashCardResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularylinechart/numberofwordslearned/languagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets words learned line chart by language learning", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByLanguageLearningResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularyroundchart/proficiency/flashCard": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get Proficiency By FlashCard", "parameters": [ { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByFlashCardResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByFlashCardResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByFlashCardResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/vocabularyroundchart/proficiency/languagelearning": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get Proficiency By Language Learning", "parameters": [ { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByLanguageLearningResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByLanguageLearningResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyByLanguageLearningResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammaroverview/proficiency": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets proficiency Overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammaroverview/sentences": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets number of sentences practiced Overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammaroverview/topics": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets number of topics learned overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammarroundchart/proficiency": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get proficiency Chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveProficiencyChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammarlinechart/sentences": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get Sentence learned Chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveSentenceChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/grammarlinechart/topics": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get topic learned Chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveTopicChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readingoverview/books": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets books completed overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readingoverview/chapters": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets chapters completed overview", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterOverviewResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readinglinechart/bookscompleted": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets books completed line chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookLineChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookLineChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookLineChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readingroundchart/bookscompleted": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets books completed round chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveBookRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readinglinechart/chapterscompleted": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets chapter completed line chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterLineChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterLineChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterLineChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readingroundchart/chapterscompleted": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Gets chapter completed round chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveChapterRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/collectivedashboard/readingroundchart/wordslearned": { "get": { "tags": [ "CollectiveDashboard" ], "summary": "Get Word Round Chart", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentLesson", "in": "query", "schema": { "type": "string" } }, { "name": "Languages", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "ClassRoomCodes", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCollectiveWordRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/countries/all": { "get": { "tags": [ "Countries" ], "summary": "Gets the countries.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "Comparison", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCountriesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCountriesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCountriesResponseBiblingoAPIResponse" } } } } } } }, "/course/all": { "get": { "tags": [ "Course" ], "summary": "Gets the courses.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCoursesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCoursesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCoursesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/customdeck/all": { "get": { "tags": [ "CustomDeck" ], "summary": "Get all custom deck names.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/customdeck/addword": { "put": { "tags": [ "CustomDeck" ], "summary": "Add Word To Deck", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddWordToCustomDeckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddWordToCustomDeckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddWordToCustomDeckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddWordToCustomDeckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/dataSeed/SeedAvatars": { "get": { "tags": [ "DataSeed" ], "summary": "Reseeds the master avatar and levelConfig data. Deletes existing set and recreates new.", "parameters": [ { "name": "request", "in": "query", "description": "Biblingo.Application.Services.System.Commands.SeedData.SeedUpdateDataRequest", "schema": { "$ref": "#/components/schemas/SeedUpdateDataRequest" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/dbconsole/query/execute": { "post": { "tags": [ "DBConsole" ], "summary": "Gets the logs from application.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "sqlQueryFile": { "type": "string", "format": "binary" } } }, "encoding": { "sqlQueryFile": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/deckactivity/get/{id}": { "get": { "tags": [ "DeckActivity" ], "summary": "Gets the activity.", "parameters": [ { "name": "id", "in": "path", "description": "The Activity Id.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/verify": { "post": { "tags": [ "DeckActivity" ], "summary": "Verify deck activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyDeckAnswerResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/skip/{id}": { "post": { "tags": [ "DeckActivity" ], "summary": "Execute skip deck activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/previous/{id}": { "post": { "tags": [ "DeckActivity" ], "summary": "Execute previous deck activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreviousDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreviousDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviousDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/next/{id}": { "post": { "tags": [ "DeckActivity" ], "summary": "Execute next deck activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } }, { "name": "runningTimeInMilliseconds", "in": "query", "description": "The time in milliseconds spent by the user thus far in this iteration of the activity.", "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "pointsCategory", "in": "query", "description": "The Biblingo.Domain.Enums.ActivityPointsCategory for which the user requested to earn points by completing the activity.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/backtoassociation/{id}": { "post": { "tags": [ "DeckActivity" ], "summary": "Back to deck association activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackToDeckAssociationResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackToDeckAssociationResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackToDeckAssociationResponseBiblingoAPIResponse" } } } } } } }, "/deckactivity/backtolearning/{id}": { "post": { "tags": [ "DeckActivity" ], "summary": "Back to deck learning activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackToDeckLearningResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackToDeckLearningResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackToDeckLearningResponseBiblingoAPIResponse" } } } } } } }, "/deck/groups": { "get": { "tags": [ "Decks" ], "summary": "Get deck groups.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DeckType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckGroupsResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckGroupsResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckGroupsResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/deck/overview": { "get": { "tags": [ "Decks" ], "summary": "Gets deck overview.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DeckType", "in": "query", "schema": { "type": "string" } }, { "name": "Group", "in": "query", "schema": { "type": "string" } }, { "name": "IsShared", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsCustomDeck", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "IsGenerated", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "SharedByUserID", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckOverviewResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckOverviewResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckOverviewResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/deck/status/{id}": { "get": { "tags": [ "Decks" ], "summary": "Gets the deck status.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckStatusResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckStatusResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckStatusResponseBiblingoAPIResponse" } } } } } } }, "/deck/get": { "get": { "tags": [ "Decks" ], "summary": "Gets the deck.", "parameters": [ { "name": "id", "in": "query", "description": "The deck id", "schema": { "type": "integer", "format": "int64" } }, { "name": "isRestart", "in": "query", "description": "Whether to restart the deck", "schema": { "type": "boolean" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Whether to returnt he illustrations for the thumbnails.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckResponseBiblingoAPIResponse" } } } } } } }, "/deckstage/get/{id}": { "get": { "tags": [ "DeckStage" ], "summary": "Gets the learning deck stage.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDeckStageResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDeckStageResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDeckStageResponseBiblingoAPIResponse" } } } } } } }, "/ENUM/all": { "get": { "tags": [ "ENUM" ], "summary": "Gets the ENUM list.", "parameters": [ { "name": "Type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/recommendations/exercises": { "get": { "tags": [ "ExerciseRecommendations" ], "summary": "Gets the exercises the system recommends the user complete next for a given language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetNextExerciseRecommendationsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetNextExerciseRecommendationsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNextExerciseRecommendationsResponseBiblingoAPIResponse" } } } } } } }, "/family/members": { "get": { "tags": [ "Family" ], "summary": "Gets the caller's family members with a furthest-lesson badge.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFamilyMembersResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFamilyMembersResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFamilyMembersResponseBiblingoAPIResponse" } } } } } } }, "/family/lessons": { "get": { "tags": [ "Family" ], "summary": "Gets the per-lesson score grid over the caller's family members for a language\r\nand content grouping (same shape as teacherdashboard/lessons).", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFamilyLessonsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFamilyLessonsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFamilyLessonsResponseBiblingoAPIResponse" } } } } } } }, "/filehistory/getall": { "get": { "tags": [ "FileHistory" ], "summary": "The get file history async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "FileType", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/filehistory/approve": { "put": { "tags": [ "FileHistory" ], "summary": "The approve file version async.", "parameters": [ { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FileType", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/filehistory/delete": { "delete": { "tags": [ "FileHistory" ], "summary": "The Delete File History Async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/get": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The get flash card deck settings asynchronous.", "parameters": [ { "name": "language", "in": "query", "description": "The language.", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckSettingsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckSettingsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckSettingsResponseBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/decks": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The get flash card decks asynchronous.", "parameters": [ { "name": "GroupID", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFlashCardDecksResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDecksResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDecksResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/groups": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The get flash card deck groups asynchronous.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DisplaySharedGroups", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckGroupsResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckGroupsResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckGroupsResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/words": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The get flash card deck words asynchronous.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckEntriesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckEntriesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFlashCardDeckEntriesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/semanticdomainentries": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The get semantic domain entries async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SensesToInclude", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSemanticDomainEntriesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSemanticDomainEntriesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSemanticDomainEntriesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/words/search": { "get": { "tags": [ "FlashCardDeckSettings" ], "summary": "The search words for flash card decks async.", "parameters": [ { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SearchWordsForDeckResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SearchWordsForDeckResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SearchWordsForDeckResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/add": { "post": { "tags": [ "FlashCardDeckSettings" ], "summary": "Add new flash card deck asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/word/add": { "post": { "tags": [ "FlashCardDeckSettings" ], "summary": "Add word to flash card deck asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckEntryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckEntryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckEntryRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddFlashCardDeckEntryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/generatebybiblebook": { "post": { "tags": [ "FlashCardDeckSettings" ], "summary": "The generate flash card deck by book asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDeckByBibleReadingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateDeckByBibleReadingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateDeckByBibleReadingRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenerateDeckByBibleReadingRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/generatebysemanticdomain": { "post": { "tags": [ "FlashCardDeckSettings" ], "summary": "The generate flash card deck by semantic domain async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDeckBySemanticDomainRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateDeckBySemanticDomainRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateDeckBySemanticDomainRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenerateDeckBySemanticDomainRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/word/update": { "put": { "tags": [ "FlashCardDeckSettings" ], "summary": "The update flash card deck entry async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditFlashCardDeckEntryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditFlashCardDeckEntryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditFlashCardDeckEntryRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditFlashCardDeckEntryRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/change": { "put": { "tags": [ "FlashCardDeckSettings" ], "summary": "The update flash card deck settings asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFlashCardDeckSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFlashCardDeckSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFlashCardDeckSettingsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateFlashCardDeckSettingsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/move": { "put": { "tags": [ "FlashCardDeckSettings" ], "summary": "The move flash card deck asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveFlashCardDeckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MoveFlashCardDeckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MoveFlashCardDeckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MoveFlashCardDeckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/share": { "put": { "tags": [ "FlashCardDeckSettings" ], "summary": "The share flash card deck.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareFlashCardDeckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShareFlashCardDeckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ShareFlashCardDeckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ShareFlashCardDeckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/sync": { "put": { "tags": [ "FlashCardDeckSettings" ], "summary": "The sync custom decks.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/deck/delete/{id}": { "delete": { "tags": [ "FlashCardDeckSettings" ], "summary": "The delete flash card deck asynchronous.", "parameters": [ { "name": "id", "in": "path", "description": "The deck id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/group/delete/{id}": { "delete": { "tags": [ "FlashCardDeckSettings" ], "summary": "The delete flash card deck group asynchronous.", "parameters": [ { "name": "id", "in": "path", "description": "The id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/flashcarddecksettings/word/delete/{id}": { "delete": { "tags": [ "FlashCardDeckSettings" ], "summary": "The delete flash card deck word asynchronous.", "parameters": [ { "name": "id", "in": "path", "description": "The id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/fluencydrill/get/{id}": { "get": { "tags": [ "FluencyDrill" ], "summary": "Gets the fluency drill.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrillactivity/verify": { "post": { "tags": [ "FluencyDrillActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrillactivity/skip/{id}": { "post": { "tags": [ "FluencyDrillActivity" ], "summary": "Execute skip activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillActivityResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrillactivity/next/{id}": { "post": { "tags": [ "FluencyDrillActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillActivityResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/forlesson": { "get": { "tags": [ "FluencyDrillDeck" ], "summary": "Gets the fluency drill deck for lesson.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonFluencyDrillDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonFluencyDrillDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonFluencyDrillDecksResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/forothers": { "get": { "tags": [ "FluencyDrillDeck" ], "summary": "Gets the fluency drill deck for others.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetOtherFluencyDrillDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetOtherFluencyDrillDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetOtherFluencyDrillDecksResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/forpractice": { "get": { "tags": [ "FluencyDrillDeck" ], "summary": "Gets the fluency drill deck for practice.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DeckType", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPracticeFluencyDrillDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPracticeFluencyDrillDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPracticeFluencyDrillDecksResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/get/{id}": { "get": { "tags": [ "FluencyDrillDeck" ], "summary": "Gets the fluency drill deck.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillDeckResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillDeckResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillDeckResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/archive/{id}": { "put": { "tags": [ "FluencyDrillDeck" ], "summary": "Archive fluency drill deck.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeck/unarchive/{id}": { "put": { "tags": [ "FluencyDrillDeck" ], "summary": "Un_archive fluency drill deck.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeckactivity/verify": { "post": { "tags": [ "FluencyDrillDeckActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeckactivity/skip/{id}": { "post": { "tags": [ "FluencyDrillDeckActivity" ], "summary": "Execute skip activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipFluencyDrillDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrilldeckactivity/next/{id}": { "post": { "tags": [ "FluencyDrillDeckActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "runningTimeInMilliseconds", "in": "query", "description": "The time in milliseconds spent by the user thus far in this iteration of the activity.", "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "pointsCategory", "in": "query", "description": "The Biblingo.Domain.Enums.ActivityPointsCategory for which the user requested to earn points by completing the activity.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextFluencyDrillDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrillsettings/get": { "get": { "tags": [ "FluencyDrillSettings" ], "summary": "The get fluency drill settings.", "parameters": [ { "name": "language", "in": "query", "description": "The language.", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillSettingsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillSettingsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillSettingsResponseBiblingoAPIResponse" } } } } } } }, "/fluencydrillsettings/change": { "put": { "tags": [ "FluencyDrillSettings" ], "summary": "The update fluency drill settings async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFluencyDrillSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateFluencyDrillSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateFluencyDrillSettingsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateFluencyDrillSettingsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/friends": { "get": { "tags": [ "Friends" ], "summary": "Lists the users the current user follows for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } } } } } } }, "/friends/followers": { "get": { "tags": [ "Friends" ], "summary": "Lists the users who follow the current user for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FriendCardModelIEnumerableBiblingoAPIResponse" } } } } } } }, "/friends/blocked": { "get": { "tags": [ "Friends" ], "summary": "Lists the users the current user has blocked.", "parameters": [ { "name": "request", "in": "query", "description": "The request.", "schema": { "$ref": "#/components/schemas/GetBlockedRequest" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BlockedUserModelIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BlockedUserModelIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlockedUserModelIEnumerableBiblingoAPIResponse" } } } } } } }, "/friends/requests": { "get": { "tags": [ "Friends" ], "summary": "Lists incoming (pending) follow requests for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IncomingFollowRequestModelIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IncomingFollowRequestModelIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IncomingFollowRequestModelIEnumerableBiblingoAPIResponse" } } } } } } }, "/friends/search": { "get": { "tags": [ "Friends" ], "summary": "Searches for a user by email to follow.", "parameters": [ { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SearchFriendResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SearchFriendResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SearchFriendResponseBiblingoAPIResponse" } } } } } } }, "/friends/follow": { "post": { "tags": [ "Friends" ], "summary": "Requests to follow a user for a language.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestFollowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestFollowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestFollowRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RequestFollowRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/friends/accept": { "post": { "tags": [ "Friends" ], "summary": "Accepts an incoming follow request.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptFollowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptFollowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcceptFollowRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AcceptFollowRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AcceptFollowResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AcceptFollowResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptFollowResponseBiblingoAPIResponse" } } } } } } }, "/friends/follow-back": { "post": { "tags": [ "Friends" ], "summary": "Follows back someone who already follows the current user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FollowBackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FollowBackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FollowBackRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FollowBackRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FollowBackResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FollowBackResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FollowBackResponseBiblingoAPIResponse" } } } } } } }, "/friends/ignore": { "post": { "tags": [ "Friends" ], "summary": "Ignores an incoming follow request.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoreFollowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IgnoreFollowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IgnoreFollowRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IgnoreFollowRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/friends/unfollow": { "post": { "tags": [ "Friends" ], "summary": "Stops following a user for a language.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnfollowRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnfollowRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnfollowRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UnfollowRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/friends/followers/remove": { "post": { "tags": [ "Friends" ], "summary": "Removes a follower — revokes their follow of the current user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RemoveFollowerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RemoveFollowerResponseBiblingoAPIResponse" } } } } } } }, "/friends/block": { "post": { "tags": [ "Friends" ], "summary": "Blocks a user in every language, and drops both follows.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlockUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BlockUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BlockUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/friends/unblock": { "post": { "tags": [ "Friends" ], "summary": "Lifts a block.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnblockUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnblockUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnblockUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UnblockUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/fuller/enroll": { "post": { "tags": [ "Fuller" ], "summary": "Enroll user asynchronous", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrollFullerUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EnrollFullerUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EnrollFullerUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EnrollFullerUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/fuller/unenroll": { "put": { "tags": [ "Fuller" ], "summary": "Delete course for a user asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFullerUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteFullerUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteFullerUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteFullerUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/lessons": { "get": { "tags": [ "Grammar" ], "summary": "Gets all lessons for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Text", "in": "query", "schema": { "type": "string" } }, { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/all": { "get": { "tags": [ "Grammar" ], "summary": "Gets all grammar for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Lesson", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Text", "in": "query", "schema": { "type": "string" } }, { "name": "Topic", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Problem", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "OrderLocation", "in": "query", "schema": { "type": "string" } }, { "name": "Section", "in": "query", "schema": { "type": "string" } }, { "name": "RefId", "in": "query", "schema": { "type": "string" } }, { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/intro": { "get": { "tags": [ "Grammar" ], "summary": "Gets the resource.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "LessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/l10n/intro": { "get": { "tags": [ "Grammar" ], "summary": "Gets the resource localization.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "LessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/upload": { "post": { "tags": [ "Grammar" ], "summary": "Upload grammar file for different languages.", "parameters": [ { "name": "language", "in": "query", "description": "Gets the language.", "schema": { "type": "string", "default": "" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadGrammarResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadGrammarResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadGrammarResponseBiblingoAPIResponse" } } } } } } }, "/grammar/mapintro": { "put": { "tags": [ "Grammar" ], "summary": "Maps the resource.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapResourceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MapResourceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MapResourceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MapResourceRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/l10n/mapintro": { "put": { "tags": [ "Grammar" ], "summary": "Maps the resource localization.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapResourceLocalizationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MapResourceLocalizationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MapResourceLocalizationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MapResourceLocalizationRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/grammar/deleteintro": { "delete": { "tags": [ "Grammar" ], "summary": "Delete introduction video.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Culture", "in": "query", "schema": { "type": "string" } }, { "name": "LessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/internaluser/get/{id}": { "get": { "tags": [ "InternalUser" ], "summary": "Gets the profile of a User", "parameters": [ { "name": "id", "in": "path", "description": "Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetUserResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetUserResponseBiblingoAPIResponse" } } } } } } }, "/internaluser/all": { "get": { "tags": [ "InternalUser" ], "summary": "Get all User.", "parameters": [ { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Address", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "CountryName", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Roles", "in": "query", "schema": { "type": "array", "items": { "enum": [ "Admin", "InternalTeacher", "ExternalTeacher", "Student", "Thirdparty" ], "type": "string" } } }, { "name": "Role", "in": "query", "schema": { "type": "string" } }, { "name": "CreatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/internaluser/create": { "post": { "tags": [ "InternalUser" ], "summary": "Create a User", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/internaluser/edit": { "put": { "tags": [ "InternalUser" ], "summary": "Edit a User", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditUserRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditUserRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/internaluser/delete": { "delete": { "tags": [ "InternalUser" ], "summary": "Delete a User", "parameters": [ { "name": "id", "in": "query", "description": "Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/language/status": { "get": { "tags": [ "Language" ], "summary": "Get language file status.", "responses": { "200": { "description": "Success" } } } }, "/learning/points": { "get": { "tags": [ "Learning" ], "summary": "Gets the points.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPointsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPointsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPointsResponseBiblingoAPIResponse" } } } } } } }, "/reasons/all": { "get": { "tags": [ "LearningReason" ], "summary": "Gets the learning reasons.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReasonsResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReasonsResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReasonsResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/learningsettings/get": { "get": { "tags": [ "LearningSettings" ], "summary": "The get learning settings.", "parameters": [ { "name": "language", "in": "query", "description": "The language.", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLearningSettingsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLearningSettingsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLearningSettingsResponseBiblingoAPIResponse" } } } } } } }, "/learningsettings/change": { "put": { "tags": [ "LearningSettings" ], "summary": "The update learning settings async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLearningSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateLearningSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateLearningSettingsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateLearningSettingsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/activity/get/{id}": { "get": { "tags": [ "LessonActivity" ], "summary": "Gets the activity.", "parameters": [ { "name": "id", "in": "path", "description": "The Activity Id.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetActivityResponseBiblingoAPIResponse" } } } } } } }, "/activity/verify": { "post": { "tags": [ "LessonActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyAnswerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyAnswerResponseBiblingoAPIResponse" } } } } } } }, "/activity/spellcheck": { "post": { "tags": [ "LessonActivity" ], "summary": "Spell check activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpellCheckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpellCheckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SpellCheckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SpellCheckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpellCheckResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpellCheckResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpellCheckResponseBiblingoAPIResponse" } } } } } } }, "/activity/skip/{id}": { "post": { "tags": [ "LessonActivity" ], "summary": "Execute skip activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipActivityResponseBiblingoAPIResponse" } } } } } } }, "/activity/previous/{id}": { "post": { "tags": [ "LessonActivity" ], "summary": "Execute previous activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PreviousActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PreviousActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PreviousActivityResponseBiblingoAPIResponse" } } } } } } }, "/activity/next/{id}": { "post": { "tags": [ "LessonActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } }, { "name": "runningTimeInMilliseconds", "in": "query", "description": "The time in milliseconds spent by the user thus far in this iteration of the activity.", "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "pointsCategory", "in": "query", "description": "The Biblingo.Domain.Enums.ActivityPointsCategory for which the user requested to earn points by completing the activity.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextActivityResponseBiblingoAPIResponse" } } } } } } }, "/activity/backtoassociation/{id}": { "post": { "tags": [ "LessonActivity" ], "summary": "Back to association activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackToAssociationResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackToAssociationResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackToAssociationResponseBiblingoAPIResponse" } } } } } } }, "/activity/backtolearning/{id}": { "post": { "tags": [ "LessonActivity" ], "summary": "Back to learning activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BackToLearningResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BackToLearningResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackToLearningResponseBiblingoAPIResponse" } } } } } } }, "/lessondeck/get/{id}": { "get": { "tags": [ "LessonDeck" ], "summary": "Get a Lesson Deck By Id", "parameters": [ { "name": "id", "in": "path", "description": "Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lessondeck/all": { "get": { "tags": [ "LessonDeck" ], "summary": "Get all lesson decks", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lessondeck/create": { "post": { "tags": [ "LessonDeck" ], "summary": "Create a lesson deck.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lessonguides/map": { "post": { "tags": [ "LessonGuide" ], "summary": "Map lesson guides.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lesson/overview": { "get": { "tags": [ "Lessons" ], "summary": "Gets lessons overview.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetOverviewResponseBiblingoAPIResponse" } } } } } } }, "/lesson/overview/slim": { "get": { "tags": [ "Lessons" ], "summary": "Gets lessons overview.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetOverviewSlimResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetOverviewSlimResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetOverviewSlimResponseBiblingoAPIResponse" } } } } } } }, "/lesson/foruser": { "get": { "tags": [ "Lessons" ], "summary": "The get lessons for user async.", "parameters": [ { "name": "language", "in": "query", "description": "The language.", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonsForUserResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonsForUserResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonsForUserResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/lesson/status/{id}": { "get": { "tags": [ "Lessons" ], "summary": "Gets the lesson status.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonStatusResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonStatusResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonStatusResponseBiblingoAPIResponse" } } } } } } }, "/lesson/get/{id}": { "get": { "tags": [ "Lessons" ], "summary": "Gets the lesson.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonResponseBiblingoAPIResponse" } } } } } } }, "/lesson/progress": { "put": { "tags": [ "Lessons" ], "summary": "Skips a students progress forward by making lessons complete, unlocking next lesson. Language: enter number, ie 0 for Hebrew, 1 for Greek. LessonNumber, use range 1-208, ie enter 8 for lesson 2.4.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgressLessonRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProgressLessonRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProgressLessonRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProgressLessonRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lesson/maptopics": { "put": { "tags": [ "Lessons" ], "summary": "Map topic names.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/lessonstage/get/{id}": { "get": { "tags": [ "LessonStage" ], "summary": "Gets the lesson stage.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "withThumbnailIllustrations", "in": "query", "description": "Should the associated thumbnail illustrations be returned.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetStageResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetStageResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetStageResponseBiblingoAPIResponse" } } } } } } }, "/lessonstage/lastCompleted": { "get": { "tags": [ "LessonStage" ], "summary": "Gets the lesson stage.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonStageLastCompletedResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonStageLastCompletedResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonStageLastCompletedResponseBiblingoAPIResponse" } } } } } } }, "/localization/cultures/all": { "get": { "tags": [ "Localization" ], "summary": "Get all cultures (localization language targets). Useful for getting the CultureId for a given target language.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetCulturesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetCulturesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetCulturesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/localization/resources/all": { "get": { "tags": [ "Localization" ], "summary": "Get all resources (localization strings).", "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetResourcesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetResourcesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetResourcesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/localization/culture/create": { "post": { "tags": [ "Localization" ], "summary": "Create a culture (target localization language).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCultureRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCultureRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCultureRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateCultureRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/localization/resources/bulkupload": { "post": { "tags": [ "Localization" ], "summary": "Bulk uploads localization strings to the Resources table. Upload a csv file for the target CultureId.", "parameters": [ { "name": "id", "in": "query", "description": "Specify the target CultureId.", "schema": { "type": "integer", "format": "int64" } }, { "name": "modules", "in": "query", "description": "Specify the modules to use the resources on. Use '0,1,2' as default.", "schema": { "type": "string", "default": "" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/localization/culture/delete": { "delete": { "tags": [ "Localization" ], "summary": "Delete a culture.", "parameters": [ { "name": "id", "in": "query", "description": "Gets the Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/media/all": { "get": { "tags": [ "Media" ], "summary": "Gets all media files.", "parameters": [ { "name": "MediaType", "in": "query", "schema": { "type": "string" } }, { "name": "FileName", "in": "query", "schema": { "type": "string" } }, { "name": "IgnoreCache", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/media/upload": { "post": { "tags": [ "Media" ], "summary": "Uploads the media asynchronous.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" }, "thumbnailFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" }, "thumbnailFile": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/media/bulkupload": { "post": { "tags": [ "Media" ], "summary": "Bulk uploads the media asynchronous.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/media/rename": { "put": { "tags": [ "Media" ], "summary": "Rename Media File Asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameMediaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenameMediaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenameMediaRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RenameMediaRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/media/delete": { "delete": { "tags": [ "Media" ], "summary": "Delete Media file.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteMediaRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DeleteMediaRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/placement/get": { "get": { "tags": [ "PlacementTest" ], "summary": "Gets the placement test.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPlacementTestResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPlacementTestResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPlacementTestResponseBiblingoAPIResponse" } } } } } } }, "/placementtestactivity/next/{id}": { "post": { "tags": [ "PlacementTestActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextPlacementTestActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextPlacementTestActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextPlacementTestActivityResponseBiblingoAPIResponse" } } } } } } }, "/placementtestactivity/verify": { "post": { "tags": [ "PlacementTestActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerResponseBiblingoAPIResponse" } } } } } } }, "/planner/lesson/all": { "get": { "tags": [ "Planner" ], "summary": "Get all lesson plans.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsViewDetails", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/practice/all": { "get": { "tags": [ "Planner" ], "summary": "Get all practice plans.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsViewDetails", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/all": { "get": { "tags": [ "Planner" ], "summary": "Get all reading plans.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsViewDetails", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/lesson/estimatedenddate": { "get": { "tags": [ "Planner" ], "summary": "The get lesson plan estimated end date async.", "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Start", "in": "query", "schema": { "type": "string" } }, { "name": "End", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Pace", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Days", "in": "query", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/getestimateddate": { "get": { "tags": [ "Planner" ], "summary": "Get estimated reading end date.", "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Testament", "in": "query", "schema": { "type": "string" } }, { "name": "ReadingPlanType", "in": "query", "schema": { "type": "string" } }, { "name": "FromBookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromChapter", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToBookId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ToChapter", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Pace", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Days", "in": "query", "schema": { "type": "string" } }, { "name": "StartDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/range": { "get": { "tags": [ "Planner" ], "summary": "The get reading range async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "StartFromBookID", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FinishUptoBookID", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ToChapter", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromChapter", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReadingRangeResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReadingRangeResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReadingRangeResponseBiblingoAPIResponse" } } } } } } }, "/planner/lesson/create": { "post": { "tags": [ "Planner" ], "summary": "Create Lesson Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLessonPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLessonPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLessonPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLessonPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/practice/create": { "post": { "tags": [ "Planner" ], "summary": "Create Practice Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePracticeGoalsPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePracticeGoalsPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePracticeGoalsPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePracticeGoalsPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/create": { "post": { "tags": [ "Planner" ], "summary": "Create Reading Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReadingPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReadingPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReadingPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateReadingPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/lesson/edit": { "put": { "tags": [ "Planner" ], "summary": "Edit Lesson Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditLessonPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditLessonPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditLessonPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditLessonPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/practice/edit": { "put": { "tags": [ "Planner" ], "summary": "Edit Practice Goals Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditPracticeGoalsPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditPracticeGoalsPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditPracticeGoalsPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditPracticeGoalsPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/edit": { "put": { "tags": [ "Planner" ], "summary": "Edit Reading Plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditReadingPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditReadingPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditReadingPlanRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditReadingPlanRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/lesson/plan/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete lesson plan async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/plan/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete reading plan async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/practice/plan/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete practice plan async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/lesson/task/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete lesson task async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/reading/task/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete reading task async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/planner/practice/task/delete": { "delete": { "tags": [ "Planner" ], "summary": "The delete practice task async.", "parameters": [ { "name": "id", "in": "query", "description": "The id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/practicedeck/overview": { "get": { "tags": [ "PracticeDeck" ], "summary": "Gets practice deck overview.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/practicedeck/archive/{id}": { "delete": { "tags": [ "PracticeDeck" ], "summary": "Archive Word", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/practicedeck/update": { "put": { "tags": [ "PracticeDeck" ], "summary": "Update Practice Deck Async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/presetdeck/get/{id}": { "get": { "tags": [ "PresetDeck" ], "summary": "Get a Preset Deck By Id", "parameters": [ { "name": "id", "in": "path", "description": "Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/presetdeck/all": { "get": { "tags": [ "PresetDeck" ], "summary": "Get all Preset decks", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/presetdeck/create": { "post": { "tags": [ "PresetDeck" ], "summary": "Create a preset deck.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/question/get/{id}": { "get": { "tags": [ "QA" ], "summary": "Get the question.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success" } } } }, "/question/all": { "get": { "tags": [ "QA" ], "summary": "Get all questions.", "parameters": [ { "name": "Title", "in": "query", "schema": { "type": "string" } }, { "name": "Description", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "QuestionType", "in": "query", "schema": { "type": "string" } }, { "name": "AskedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsDuplicate", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "ShowOnlyForClass", "in": "query", "schema": { "type": "boolean" } }, { "name": "ShowAll", "in": "query", "schema": { "type": "boolean" } }, { "name": "AskedByUserId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "AnsweredOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "HasAnswers", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "HasVerifiedAnswer", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "QuestionRefNo", "in": "query", "schema": { "type": "string" } }, { "name": "RefID", "in": "query", "schema": { "type": "string" } }, { "name": "LessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "OrderingLocation", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/answer/get/{id}": { "get": { "tags": [ "QA" ], "summary": "Get the answer.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success" } } } }, "/answer/all": { "get": { "tags": [ "QA" ], "summary": "Get all answers.", "parameters": [ { "name": "QuestionId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "IsVerified", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "Description", "in": "query", "schema": { "type": "string" } }, { "name": "AnsweredOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "VerifiedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "AnsweredByUserId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "VerifiedByUserId", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/question/create": { "post": { "tags": [ "QA" ], "summary": "Create a Question.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQuestionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateQuestionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateQuestionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateQuestionRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/question/ask": { "post": { "tags": [ "QA" ], "summary": "Ask a Question.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskQuestionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AskQuestionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AskQuestionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AskQuestionRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/answer/post": { "post": { "tags": [ "QA" ], "summary": "Post answers for questions.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/answer/verify/{id}": { "put": { "tags": [ "QA" ], "summary": "Verify Answer.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/answer/edit": { "put": { "tags": [ "QA" ], "summary": "Edit Answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditAnswerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditAnswerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditAnswerRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditAnswerRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/question/delete/{id}": { "delete": { "tags": [ "QA" ], "summary": "Delete Question.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/answer/delete/{id}": { "delete": { "tags": [ "QA" ], "summary": "Delete Answer.", "parameters": [ { "name": "id", "in": "path", "description": "Gets the Id.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/readingcomprehension/get/{id}": { "get": { "tags": [ "ReadingComprehension" ], "summary": "Gets the reading comprehension.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReadComprehensionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReadComprehensionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReadComprehensionResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensionactivity/verify": { "post": { "tags": [ "ReadingComprehensionActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensionactivity/skip/{id}": { "post": { "tags": [ "ReadingComprehensionActivity" ], "summary": "Execute skip activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionActivityResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensionactivity/next/{id}": { "post": { "tags": [ "ReadingComprehensionActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionActivityResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeck/forlesson": { "get": { "tags": [ "ReadingComprehensionDeck" ], "summary": "Gets the reading comprehension deck for lesson.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonReadingComprehensionDecksResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeck/forbank": { "get": { "tags": [ "ReadingComprehensionDeck" ], "summary": "Gets the reading comprehension decks for the Bank tab.\r\nReturns Lesson-type story decks (so completions sync with Learn), plus any\r\nOther-type stories that have no Lesson-type counterpart.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBankReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBankReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBankReadingComprehensionDecksResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeck/forothers": { "get": { "tags": [ "ReadingComprehensionDeck" ], "summary": "Gets the reading comprehension deck for others.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "SearchTerm", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetOtherReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetOtherReadingComprehensionDecksResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetOtherReadingComprehensionDecksResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeck/get/{id}": { "get": { "tags": [ "ReadingComprehensionDeck" ], "summary": "Gets the reading comprehension deck.", "parameters": [ { "name": "id", "in": "path", "description": "Get the ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionDeckResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionDeckResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionDeckResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeckactivity/verify": { "post": { "tags": [ "ReadingComprehensionDeckActivity" ], "summary": "Verify activity answer.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeckactivity/skip/{id}": { "post": { "tags": [ "ReadingComprehensionDeckActivity" ], "summary": "Execute skip activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SkipReadComprehensionDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/readingcomprehensiondeckactivity/next/{id}": { "post": { "tags": [ "ReadingComprehensionDeckActivity" ], "summary": "Execute next activity.", "parameters": [ { "name": "id", "in": "path", "description": "The activity Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "runningTimeInMilliseconds", "in": "query", "description": "The time in milliseconds spent by the user thus far in this iteration of the activity.", "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "pointsCategory", "in": "query", "description": "The Biblingo.Domain.Enums.ActivityPointsCategory for which the user requested to earn points by completing the activity.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionDeckActivityResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NextReadComprehensionDeckActivityResponseBiblingoAPIResponse" } } } } } } }, "/searchhistory/get/{id}": { "get": { "tags": [ "SearchHistory" ], "summary": "Gets the search history.", "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSearchHistoryResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSearchHistoryResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSearchHistoryResponseBiblingoAPIResponse" } } } } } } }, "/searchhistory/all": { "get": { "tags": [ "SearchHistory" ], "summary": "Gets all search histories.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSearchHistoriesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSearchHistoriesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSearchHistoriesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/sense/upvote": { "post": { "tags": [ "Sense" ], "summary": "Up Vote For Sense Async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/sense/downvote": { "delete": { "tags": [ "Sense" ], "summary": "Down Vote For Sense Async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "OsisID", "in": "query", "schema": { "type": "string" } }, { "name": "StrongsNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SenseID", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSensesResponseBiblingoAPIResponse" } } } } } } }, "/session/log": { "post": { "tags": [ "SessionLog" ], "summary": "Log session.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LogSessionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LogSessionRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogSessionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogSessionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogSessionResponseBiblingoAPIResponse" } } } } } } }, "/shareddashboard/learningdata": { "get": { "tags": [ "SharedDashboard" ], "summary": "Gets a learner's learning-data dashboard (S0 payload).", "parameters": [ { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLearnerDashboardResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLearnerDashboardResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLearnerDashboardResponseBiblingoAPIResponse" } } } } } } }, "/shareddashboard/xp-history": { "get": { "tags": [ "SharedDashboard" ], "summary": "Gets a learner's weekly XP history for the trend chart (one point per Biblingo week,\r\nwith the Learn/Retain/Fluency breakdown). Same visibility gating as the dashboard.", "parameters": [ { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWeeklyXpHistoryResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWeeklyXpHistoryResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWeeklyXpHistoryResponseBiblingoAPIResponse" } } } } } } }, "/student/get/{id}": { "get": { "tags": [ "Student" ], "summary": "Gets the profile of a Student", "parameters": [ { "name": "id", "in": "path", "description": "Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetStudentResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetStudentResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetStudentResponseBiblingoAPIResponse" } } } } } } }, "/student/all": { "get": { "tags": [ "Student" ], "summary": "Get all students.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Address", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "CountryName", "in": "query", "schema": { "type": "string" } }, { "name": "UniversityOrOrganization", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "CreatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/student/lessons": { "get": { "tags": [ "Student" ], "summary": "Get all student lessons.", "parameters": [ { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/student/create": { "post": { "tags": [ "Student" ], "summary": "Create a student.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStudentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateStudentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateStudentRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateStudentRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/student/bulkupload": { "post": { "tags": [ "Student" ], "summary": "For bulk uploading user profile", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/student/notify": { "post": { "tags": [ "Student" ], "summary": "Trigger Email notification.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerEmailRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TriggerEmailRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TriggerEmailRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TriggerEmailRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/student/edit": { "put": { "tags": [ "Student" ], "summary": "Edit a Student", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditStudentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditStudentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditStudentRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditStudentRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/student/preference": { "put": { "tags": [ "Student" ], "summary": "Updates the student preference asynchronous.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatePreferenceRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/student/speaking/update": { "put": { "tags": [ "Student" ], "summary": "The update recording setting async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableSpeakingRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DisableSpeakingRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DisableSpeakingRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DisableSpeakingRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/student/delete": { "delete": { "tags": [ "Student" ], "summary": "Delete a student.", "parameters": [ { "name": "id", "in": "query", "description": "Id", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/dashboard/todo": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the todo tasks of student", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "TodoType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTodoResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTodoResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTodoResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/streak": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the current and longest streak of a Student", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetStreakResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetStreakResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetStreakResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/goal": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the plan details of a Student", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPlannerResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPlannerResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPlannerResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/recordings": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the audio recordings for a student", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "LearningSection", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetRecordingsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetRecordingsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRecordingsResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/home": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the home info of cards (Lessons and Words)", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetHomeResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetHomeResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetHomeResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/landing": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets the data to be shown in the user's Dashboard landing page.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDashboardResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDashboardResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDashboardResponseBiblingoAPIResponse" } } } } } } }, "/activity/overview/timespent": { "get": { "tags": [ "StudentDashboard" ], "summary": "The Get Time Spent Overview Async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTimeSpentOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSpentOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTimeSpentOverviewResponseBiblingoAPIResponse" } } } } } } }, "/activity/overview/days": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets number of days spent for activity overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDaysActivityOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDaysActivityOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDaysActivityOverviewResponseBiblingoAPIResponse" } } } } } } }, "/activity/overview/sessions": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets number of session for activity overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSessionActivityOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionActivityOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSessionActivityOverviewResponseBiblingoAPIResponse" } } } } } } }, "/activity/overview/points": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets point accumulated for activity overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPointActivityOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPointActivityOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPointActivityOverviewResponseBiblingoAPIResponse" } } } } } } }, "/activity/chart/daysspent": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get days spent learning async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetDaysSpentLearningResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetDaysSpentLearningResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDaysSpentLearningResponseBiblingoAPIResponse" } } } } } } }, "/activity/chart/points": { "get": { "tags": [ "StudentDashboard" ], "summary": "Get points accumulated async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPointsAccumulatedResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPointsAccumulatedResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPointsAccumulatedResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/activity/chart/numberofsessions": { "get": { "tags": [ "StudentDashboard" ], "summary": "Get number of sessions async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetNumberOfSessionsResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfSessionsResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfSessionsResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/activity/chart/timespentlearning": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get time spent learning async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTimeSpentLearningResponseListBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTimeSpentLearningResponseListBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTimeSpentLearningResponseListBiblingoAPIResponse" } } } } } } }, "/vocabulary/overview/numberofwordslearned": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get number of words learned overview async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedVocabularyOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedVocabularyOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedVocabularyOverviewResponseBiblingoAPIResponse" } } } } } } }, "/vocabulary/overview/proficiency": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get vocabulary proficiency overview async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyOverviewResponseBiblingoAPIResponse" } } } } } } }, "/vocabulary/chart/numberofwordslearned": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get number of words learned async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedResponseListBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedResponseListBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedResponseListBiblingoAPIResponse" } } } } } } }, "/vocabulary/chart/proficiency": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get vocabulary proficiency async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Module", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyProficiencyResponseBiblingoAPIResponse" } } } } } } }, "/vocabulary/getwordsineachlearningstage": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get words in each learning stage async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWordsInEachLearningStageResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWordsInEachLearningStageResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWordsInEachLearningStageResponseBiblingoAPIResponse" } } } } } } }, "/vocabulary/reports/getwordslearned": { "get": { "tags": [ "StudentDashboard" ], "summary": "The get words learned async.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "WordsLearned", "in": "query", "schema": { "type": "string" } }, { "name": "Gloss", "in": "query", "schema": { "type": "string" } }, { "name": "PercentageCorrect", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IncorrectFrequency", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Stage", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/grammar/overview/topics": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets number of topics learned for grammar overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarOverviewResponseBiblingoAPIResponse" } } } } } } }, "/grammar/overview/sentences": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets number of sentences practiced for grammar overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } } } } } } }, "/grammar/overview/proficiency": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets proficiency in grammar overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponseBiblingoAPIResponse" } } } } } } }, "/grammar/chart/topics": { "get": { "tags": [ "StudentDashboard" ], "summary": "Get Topic Grammar Chart", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTopicGrammarChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/grammar/chart/sentences": { "get": { "tags": [ "StudentDashboard" ], "summary": "Get Sentence Grammar Chart", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSentenceGrammarChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/grammar/chart/proficiency": { "get": { "tags": [ "StudentDashboard" ], "summary": "Get proficiency Grammar Chart", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetProficiencyGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetProficiencyGrammarChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetProficiencyGrammarChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/grammar/report/fluencydrill": { "get": { "tags": [ "StudentDashboard" ], "summary": "To Get Fluency Drill Report", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Paradigm", "in": "query", "schema": { "type": "string" } }, { "name": "TimesIncorrect", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Stage", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "FirstEncounter", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillReportResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillReportResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetFluencyDrillReportResponseBiblingoAPIResponse" } } } } } } }, "/grammar/report/topicslearned": { "get": { "tags": [ "StudentDashboard" ], "summary": "To Get Grammar Topic Learned Report", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Topic", "in": "query", "schema": { "type": "string" } }, { "name": "InCorrectFrequency", "in": "query", "schema": { "type": "string" } }, { "name": "SubLesson", "in": "query", "schema": { "type": "string" } }, { "name": "FirstEncounter", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGrammarTopicLearnedResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGrammarTopicLearnedResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGrammarTopicLearnedResponseBiblingoAPIResponse" } } } } } } }, "/reading/overview/chapters": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets chapters completed in reading overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChaptersReadingOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChaptersReadingOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChaptersReadingOverviewResponseBiblingoAPIResponse" } } } } } } }, "/reading/overview/Books": { "get": { "tags": [ "StudentDashboard" ], "summary": "Gets books completed in reading overview", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBooksReadingOverviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBooksReadingOverviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBooksReadingOverviewResponseBiblingoAPIResponse" } } } } } } }, "/reading/linechart/chapterscompleted": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get number of chapters completed line chart.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "BookId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/reading/linechart/bookscompleted": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get number of books completed line chart.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/reading/roundchart/wordslearned": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get words learned round chart.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedReadingRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedReadingRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetWordsLearnedReadingRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/reading/roundchart/chapterscompleted": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get chapters completed round chart.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedReadingRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/reading/roundchart/bookscompleted": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get Books completed round chart.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingRoundChartResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingRoundChartResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBooksCompletedReadingRoundChartResponseBiblingoAPIResponse" } } } } } } }, "/reading/report/chapterscompleted": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get chapters completed report.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "DateRange", "in": "query", "schema": { "type": "string" } }, { "name": "Chapter", "in": "query", "schema": { "type": "string" } }, { "name": "Percentage", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "DateCompleted", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChaptersCompletedResponseBiblingoAPIResponse" } } } } } } }, "/reading/report/readingcomprehension": { "get": { "tags": [ "StudentDashboard" ], "summary": "To get Reading Comprehension Report", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Question", "in": "query", "schema": { "type": "string" } }, { "name": "InCorrectFrequency", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "DateCompleted", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionReportResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionReportResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetReadingComprehensionReportResponseBiblingoAPIResponse" } } } } } } }, "/dashboard/addstreakday": { "post": { "tags": [ "StudentDashboard" ], "summary": "Adds credit for a missed day to a user's streak.Format: \"YYYY-MM-DD hh:mm:ss\"", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64", "nullable": true } }, { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscription": { "get": { "tags": [ "Subscription" ], "summary": "Returns the calling user's current subscription state.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionResponseBiblingoAPIResponse" } } } } } } }, "/subscription/member-social-access": { "post": { "tags": [ "Subscription" ], "summary": "A family owner allows or disallows a member seat's use of the social features\r\n(friends/classes). Set from the member's Account Details screen.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMemberSocialAccessRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetMemberSocialAccessRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetMemberSocialAccessRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetMemberSocialAccessRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscription/coupon/validate": { "post": { "tags": [ "Subscription" ], "summary": "Validates and classifies a coupon code the user entered at checkout.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateCouponRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateCouponRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ValidateCouponRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ValidateCouponRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidateCouponResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidateCouponResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidateCouponResponseBiblingoAPIResponse" } } } } } } }, "/subscription/renewal/retry": { "post": { "tags": [ "Subscription" ], "summary": "Owner-initiated \"retry payment / reactivate\": charges the customer's current primary card\r\nagainst the family's overdue seats (retrying an outstanding invoice or creating a fresh\r\nrenewal charge), bringing them current on success. Returns true when nothing is left failing.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscription/billing-history": { "get": { "tags": [ "Subscription" ], "summary": "Returns the calling subscriber's invoice history from Chargebee,\r\nmost-recent first. Supports cursor-based pagination via the\r\nlimit and offset parameters.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetBillingHistoryResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetBillingHistoryResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetBillingHistoryResponseBiblingoAPIResponse" } } } } } } }, "/subscription/billing-history/{id}/pdf": { "get": { "tags": [ "Subscription" ], "summary": "Returns a short-lived PDF download URL for a Chargebee invoice.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetInvoicePdfResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoicePdfResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetInvoicePdfResponseBiblingoAPIResponse" } } } } } } }, "/subscription/chargebee-config": { "get": { "tags": [ "Subscription" ], "summary": "Returns the Chargebee site name and publishable key needed to\r\ninitialise Chargebee.js in the browser.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetChargebeeConfigResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetChargebeeConfigResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetChargebeeConfigResponseBiblingoAPIResponse" } } } } } } }, "/subscription/payment-method": { "post": { "tags": [ "Subscription" ], "summary": "Attaches a new card to the calling subscriber's Chargebee customer\r\nusing a temporary token produced by Chargebee.js on the client.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } } } } } }, "get": { "tags": [ "Subscription" ], "summary": "Returns the calling subscriber's card on file with Chargebee.\r\nReturns 404 if no Chargebee customer exists for this user or no card is on file.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPaymentMethodResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPaymentMethodResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPaymentMethodResponseBiblingoAPIResponse" } } } } } } }, "/subscription/payment-method/{id}": { "delete": { "tags": [ "Subscription" ], "summary": "Deletes a payment method from the calling subscriber's Chargebee record.\r\nOwnership is verified — the payment source must belong to this customer.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } }, "put": { "tags": [ "Subscription" ], "summary": "Updates the cardholder name and expiry date on an existing card payment source.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "default": "" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentMethodRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentMethodRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDtoBiblingoAPIResponse" } } } } } } }, "/subscription/payment-method/{id}/make-primary": { "put": { "tags": [ "Subscription" ], "summary": "Sets a payment method as primary on the calling subscriber's Chargebee record.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscription/pricing-preview": { "post": { "tags": [ "Subscription" ], "summary": "Computes a read-only pricing preview for adding the proposed members to the\r\ncaller's family plan: per-seat amounts (with volume discounts) for the new\r\nmembers, re-rated renewal amounts for existing seats, and totals due today.\r\nNo charges are created.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetPricingPreviewResponseBiblingoAPIResponse" } } } } } } }, "/subscription/checkout": { "post": { "tags": [ "Subscription" ], "summary": "Confirms a family-plan configuration change: re-runs the authoritative pricing,\r\ncharges the subscriber via Chargebee, and provisions the resulting seats. Returns\r\nthe charge summary and provisioned seats.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CheckoutRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CheckoutResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CheckoutResponseBiblingoAPIResponse" } } } } } } }, "/subscription/configuration": { "get": { "tags": [ "Subscription" ], "summary": "Returns the currently active subscription pricing configuration.", "parameters": [ { "name": "includeDisabled", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetSubscriptionConfigurationResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionConfigurationResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetSubscriptionConfigurationResponseBiblingoAPIResponse" } } } } } }, "put": { "tags": [ "Subscription" ], "summary": "Creates a new subscription pricing configuration version. Admin only.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionConfigurationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateSubscriptionConfigurationRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscription/chargebee-webhook": { "post": { "tags": [ "Subscription" ], "summary": "Chargebee webhook receiver. Handles invoice payment events to reconcile\r\nrenewal invoices and update seat expiry/status accordingly.\r\nAuthenticated via HTTP Basic Auth (Biblingo.Application.Common.SignUp.RequestValidatorAttribute),\r\nconsistent with the existing Chargebee signup webhook on ApplicationUserController.", "responses": { "200": { "description": "Success" } } } }, "/subscriptionmanager/listplans": { "get": { "tags": [ "SubscriptionManager" ], "summary": "Lists all active subscription plans from Chargebee.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ListPlansResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ListPlansResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ListPlansResponseBiblingoAPIResponse" } } } } } } }, "/subscriptionmanager/createsubscription": { "post": { "tags": [ "SubscriptionManager" ], "summary": "Creates a new free trial subscription", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/subscriptionmanager/backfill-trial-chargebee": { "post": { "tags": [ "SubscriptionManager" ], "summary": "Admin one-off: enqueues the trial→Chargebee mirror job for every live new-model trial\r\nseat with no Chargebee carrier yet (trials that predate mirror-at-signup), so the\r\nChargebee-triggered welcome-email series covers them. Idempotent — safe to re-run.\r\nReturns the number of jobs enqueued.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Int32BiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Int32BiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Int32BiblingoAPIResponse" } } } } } } }, "/subscriptionmanager/createportalsession": { "post": { "tags": [ "SubscriptionManager" ], "summary": "Creates a portal session: an SSO access to portal for user to self manage their subscription and payments.\r\nRequires a user's email to lookup their account", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePortalSessionResponseBiblingoAPIResponse" } } } } } } }, "/subscriptionmanager/updatesubscription/activateretrial": { "post": { "tags": [ "SubscriptionManager" ], "summary": "Extends or resets the trial period for a specific user.\r\nThis endpoint accepts email and trial days via query parameters\r\nand forwards the data to the Chargebee system", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRetrialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRetrialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRetrialRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserRetrialRequest" } } } }, "responses": { "200": { "description": "Success" } } } }, "/sync/1.0/avatar/all": { "get": { "tags": [ "Sync" ], "summary": "The get latest avatars async.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestAvatarsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestAvatarsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestAvatarsResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/reason/all": { "get": { "tags": [ "Sync" ], "summary": "The get latest learning reasons async.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestLearningReasonsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestLearningReasonsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestLearningReasonsResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/course/all": { "get": { "tags": [ "Sync" ], "summary": "The get latest courses async.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestCoursesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestCoursesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestCoursesResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/status": { "get": { "tags": [ "Sync" ], "summary": "The get latest info response async.", "parameters": [ { "name": "HebrewVocabVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "HebrewGrammarVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "GreekVocabVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "GreekGrammarVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "LastSyncedOn", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestInfoResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestInfoResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestInfoResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/user/profile": { "get": { "tags": [ "Sync" ], "summary": "The get latest user info async.", "parameters": [ { "name": "LastUpdatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestUserInfoResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestUserInfoResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestUserInfoResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/classroom/all": { "get": { "tags": [ "Sync" ], "summary": "The get latest classrooms async.", "parameters": [ { "name": "LastUpdatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestClassroomsResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestClassroomsResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestClassroomsResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/sync/1.0/lessonguide/all": { "get": { "tags": [ "Sync" ], "summary": "The get latest lesson guides async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "LastUpdatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestLessonGuidesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestLessonGuidesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestLessonGuidesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/sync/1.0/vocabulary": { "get": { "tags": [ "Sync" ], "summary": "The get vocabulary latest version async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentVersion", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetVocabularyLatestVersionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyLatestVersionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetVocabularyLatestVersionResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/grammar": { "get": { "tags": [ "Sync" ], "summary": "The get grammar latest version async.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "CurrentVersion", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGrammarLatestVersionResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGrammarLatestVersionResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGrammarLatestVersionResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/resource/grammar/all": { "get": { "tags": [ "Sync" ], "summary": "The get grammar resources async.", "parameters": [ { "name": "LastUpdatedOn", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetGrammarResourcesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetGrammarResourcesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetGrammarResourcesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/sync/1.0/localization/culture/all": { "get": { "tags": [ "Sync" ], "summary": "The get cultures async.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestCulturesResponseIEnumerableBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestCulturesResponseIEnumerableBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestCulturesResponseIEnumerableBiblingoAPIResponse" } } } } } } }, "/sync/1.0/localization/resource": { "get": { "tags": [ "Sync" ], "summary": "The get resources async.", "parameters": [ { "name": "Culture", "in": "query", "schema": { "type": "string" } }, { "name": "Version", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLatestResourcesResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestResourcesResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLatestResourcesResponseBiblingoAPIResponse" } } } } } } }, "/sync/1.0/user/sessions": { "put": { "tags": [ "Sync" ], "summary": "The sync sessions async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSessionLogsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSessionLogsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSessionLogsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSessionLogsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/learning": { "put": { "tags": [ "Sync" ], "summary": "The sync learning async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestLearningRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestLearningRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestLearningRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestLearningRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/placement": { "put": { "tags": [ "Sync" ], "summary": "The sync placement tests async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPlacementTestsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPlacementTestsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPlacementTestsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPlacementTestsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/fluency": { "put": { "tags": [ "Sync" ], "summary": "The sync fluency drills async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestFluencyDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestFluencyDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestFluencyDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestFluencyDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/reading": { "put": { "tags": [ "Sync" ], "summary": "The sync reading drills async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/deck/custom": { "put": { "tags": [ "Sync" ], "summary": "The sync custom decks async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestCustomDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestCustomDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestCustomDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestCustomDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/deck/custom/user": { "put": { "tags": [ "Sync" ], "summary": "The sync user custom decks async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestUserCustomDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestUserCustomDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestUserCustomDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestUserCustomDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/deck/preset": { "put": { "tags": [ "Sync" ], "summary": "The sync preset decks async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPresetDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPresetDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPresetDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPresetDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/deck/wtnp": { "put": { "tags": [ "Sync" ], "summary": "The sync practice decks async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticeDecksRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticeDecksRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticeDecksRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticeDecksRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/deck/share": { "put": { "tags": [ "Sync" ], "summary": "The sync shared deck async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSharedDeckRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSharedDeckRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSharedDeckRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSharedDeckRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/spacedrepetition": { "put": { "tags": [ "Sync" ], "summary": "The sync spaced repetitions async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepetitionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepetitionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepetitionsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepetitionsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/spacedrepetition/fluency": { "put": { "tags": [ "Sync" ], "summary": "The sync spaced rep fluency drills async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepFluencyDrillsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepFluencyDrillsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepFluencyDrillsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestSpacedRepFluencyDrillsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/qa/questions": { "put": { "tags": [ "Sync" ], "summary": "The sync questions async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestQuestionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestQuestionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestQuestionsRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestQuestionsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/planner/lesson": { "put": { "tags": [ "Sync" ], "summary": "The sync lesson plans async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestLessonPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestLessonPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestLessonPlansRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestLessonPlansRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/planner/practice": { "put": { "tags": [ "Sync" ], "summary": "The sync practice plans async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticePlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticePlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticePlansRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestPracticePlansRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/planner/reading": { "put": { "tags": [ "Sync" ], "summary": "The sync reading plans async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingPlansRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingPlansRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingPlansRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestReadingPlansRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/classroom/mapstudent": { "put": { "tags": [ "Sync" ], "summary": "The sync latest classroom student async.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncLatestClassroomStudentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncLatestClassroomStudentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncLatestClassroomStudentRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncLatestClassroomStudentRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/sync/1.0/classroom/deleteforstudent/{rowUniqueId}": { "delete": { "tags": [ "Sync" ], "summary": "The sync latest delete classroom student async.", "parameters": [ { "name": "rowUniqueId", "in": "path", "description": "The row unique id.", "required": true, "schema": { "type": "string", "format": "uuid", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/teacherdashboard/lessons": { "get": { "tags": [ "TeacherDashboard" ], "summary": "Gets the per-lesson score grid for a class and content grouping: for each lesson,\r\natOrAbove / below / notAttempted counts and the average score per mode, against\r\nthe server-side benchmark.", "parameters": [ { "name": "ClassRoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetClassLessonsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetClassLessonsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetClassLessonsResponseBiblingoAPIResponse" } } } } } } }, "/teacherdashboard/lessonstudents": { "get": { "tags": [ "TeacherDashboard" ], "summary": "Gets per-student scores for one lesson, content and mode, sorted below, then\r\nnot attempted, then at or above.", "parameters": [ { "name": "ClassRoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "MainLessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SubLessonNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "Mode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetLessonStudentsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetLessonStudentsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetLessonStudentsResponseBiblingoAPIResponse" } } } } } } }, "/tutorial/all": { "get": { "tags": [ "Tutorial" ], "summary": "Gets the tutorials.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetTutorialsResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetTutorialsResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetTutorialsResponseBiblingoAPIResponse" } } } } } } }, "/tutorial/upload": { "post": { "tags": [ "Tutorial" ], "summary": "For uploading tutorials.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BiblingoAPIErrorResponseBiblingoAPIResponse" } } } } } } }, "/vocabulary/lessons": { "get": { "tags": [ "Vocabulary" ], "summary": "Gets all lessons for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Text", "in": "query", "schema": { "type": "string" } }, { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/vocabulary/all": { "get": { "tags": [ "Vocabulary" ], "summary": "Gets all vocabulary for a language.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "Lesson", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Order", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "Text", "in": "query", "schema": { "type": "string" } }, { "name": "RefId", "in": "query", "schema": { "type": "string" } }, { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/vocabulary/list": { "get": { "tags": [ "Vocabulary" ], "summary": "Gets list of words for a language.", "parameters": [ { "name": "Text", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "FileVersion", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "IsPagingEnabled", "in": "query", "schema": { "type": "boolean" } }, { "name": "Index", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Size", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SortBy", "in": "query", "schema": { "type": "string" } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } }, "/vocabulary/upload": { "post": { "tags": [ "Vocabulary" ], "summary": "Upload vocabulary file for different languages.", "parameters": [ { "name": "language", "in": "query", "description": "Gets the language.", "schema": { "type": "string", "default": "" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "uploadedFile": { "type": "string", "format": "binary" } } }, "encoding": { "uploadedFile": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UploadVocabularyResponseBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UploadVocabularyResponseBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UploadVocabularyResponseBiblingoAPIResponse" } } } } } } }, "/vocabularysense/sync": { "put": { "tags": [ "Vocabulary" ], "summary": "Sync vocabulary sense.", "parameters": [ { "name": "Language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BooleanBiblingoAPIResponse" } } } } } } } }, "components": { "schemas": { "AchievementBadgeSvcModel": { "type": "object", "properties": { "badgeName": { "type": "string" }, "shortName": { "type": "string" }, "shortCriteria": { "type": "string" }, "notRevealedTitle": { "type": "string" }, "revealedTitle": { "type": "string" }, "notRevealedSubtitle": { "type": "string" }, "revealedSubtitle": { "type": "string" }, "notRevealedCaption": { "type": "string" }, "revealedCaption": { "type": "string" }, "unearnedImageUrl": { "type": "string" }, "earnedImageUrl": { "type": "string" }, "earnedAnimationUrl": { "type": "string" }, "isEarned": { "type": "boolean" } }, "additionalProperties": false }, "AchievementBadgeFamilySvcModel": { "type": "object", "properties": { "family": { "type": "string" }, "majorBadges": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeSvcModel" } } } }, "additionalProperties": false }, "GetNewlyEarnedBadgesResponse": { "type": "object", "properties": { "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } } }, "additionalProperties": false }, "GetNewlyEarnedBadgesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetNewlyEarnedBadgesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetAllBadgesResponse": { "type": "object", "properties": { "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } } }, "additionalProperties": false }, "GetAllBadgesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetAllBadgesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BooleanBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "boolean" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "FileResultIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "type": "string", "format": "binary" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetRoleENUMResponse": { "type": "object", "properties": { "role": { "enum": [ "Admin", "InternalTeacher", "ExternalTeacher", "Student", "Thirdparty" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetProfileResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "culture": { "type": "string" }, "role": { "$ref": "#/components/schemas/GetRoleENUMResponse" } }, "additionalProperties": false }, "GetProfileResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetProfileResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLanguageENUMResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetLanguagesResponse": { "type": "object", "properties": { "language": { "$ref": "#/components/schemas/GetLanguageENUMResponse" } }, "additionalProperties": false }, "GetLanguagesResponseListBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetLanguagesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyEmailExistsResponse": { "type": "object", "properties": { "doesEmailExist": { "type": "boolean" } }, "additionalProperties": false }, "VerifyEmailExistsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyEmailExistsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "PlanModuleSvcModel": { "type": "object", "properties": { "isBibleReading": { "type": "boolean" }, "isFlashCardDeck": { "type": "boolean" }, "isLanguageLearning": { "type": "boolean" }, "isAlphabetDeckLearning": { "type": "boolean" }, "isVideoTutorials": { "type": "boolean" } }, "additionalProperties": false }, "LanguageCapabilitySvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "canLearn": { "type": "boolean" }, "canRead": { "type": "boolean" } }, "additionalProperties": false }, "HebrewLearningSettingsSvcModel": { "type": "object", "properties": { "isHebrewPracticePopupEnabled": { "type": "boolean" }, "weeklyPointGoal": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GreekLearningSettingsSvcModel": { "type": "object", "properties": { "isGreekPracticePopupEnabled": { "type": "boolean" }, "weeklyPointGoal": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EnglishLearningSettingsSvcModel": { "type": "object", "properties": { "isEnglishPracticePopupEnabled": { "type": "boolean" } }, "additionalProperties": false }, "LatinLearningSettingsSvcModel": { "type": "object", "properties": { "isLatinPracticePopupEnabled": { "type": "boolean" } }, "additionalProperties": false }, "AramaicLearningSettingsSvcModel": { "type": "object", "properties": { "isAramaicPracticePopupEnabled": { "type": "boolean" } }, "additionalProperties": false }, "LearningSettingsSvcModel": { "type": "object", "properties": { "hebrewLearningSettings": { "$ref": "#/components/schemas/HebrewLearningSettingsSvcModel" }, "greekLearningSettings": { "$ref": "#/components/schemas/GreekLearningSettingsSvcModel" }, "englishLearningSettings": { "$ref": "#/components/schemas/EnglishLearningSettingsSvcModel" }, "latinLearningSettings": { "$ref": "#/components/schemas/LatinLearningSettingsSvcModel" }, "aramaicLearningSettings": { "$ref": "#/components/schemas/AramaicLearningSettingsSvcModel" } }, "additionalProperties": false }, "HebrewFluencyDrillSettingsSvcModel": { "type": "object", "properties": { "numberOfQuestionsForHebrew": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GreekFluencyDrillSettingsSvcModel": { "type": "object", "properties": { "numberOfQuestionsForGreek": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EnglishFluencyDrillSettingsSvcModel": { "type": "object", "properties": { "numberOfQuestionsForEnglish": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LatinFluencyDrillSettingsSvcModel": { "type": "object", "properties": { "numberOfQuestionsForLatin": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AramaicFluencyDrillSettingsSvcModel": { "type": "object", "properties": { "numberOfQuestionsForAramaic": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FluencyDrillSettingsSvcModel": { "type": "object", "properties": { "hebrewFluencyDrillSettings": { "$ref": "#/components/schemas/HebrewFluencyDrillSettingsSvcModel" }, "greekFluencyDrillSettings": { "$ref": "#/components/schemas/GreekFluencyDrillSettingsSvcModel" }, "englishFluencyDrillSettings": { "$ref": "#/components/schemas/EnglishFluencyDrillSettingsSvcModel" }, "latinFluencyDrillSettings": { "$ref": "#/components/schemas/LatinFluencyDrillSettingsSvcModel" }, "aramaicFluencyDrillSettings": { "$ref": "#/components/schemas/AramaicFluencyDrillSettingsSvcModel" } }, "additionalProperties": false }, "AuthenticateUserResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "rowId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "subscriptionPlan": { "enum": [ "Basic", "StandardOne", "StandardTwo", "Premium", "Free" ], "type": "string" }, "subscriptionOrigin": { "enum": [ "Biblingo", "EDI" ], "type": "string" }, "role": { "$ref": "#/components/schemas/GetRoleENUMResponse" }, "isTeacher": { "type": "boolean" }, "token": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "languages": { "type": "array", "items": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "origin": { "type": "string" }, "lastLoginTime": { "type": "string", "format": "date-time", "nullable": true }, "universityOrOrganization": { "type": "boolean" }, "nativeLanguage": { "type": "boolean" }, "otherLanguages": { "type": "boolean" }, "whyAreYouStudying": { "type": "boolean" }, "yearsStudyingHebrew": { "type": "boolean" }, "yearsStudyingGreek": { "type": "boolean" }, "culture": { "type": "string" }, "expiryOn": { "type": "string", "format": "date-time" }, "isTrial": { "type": "boolean" }, "renewalPaymentFailed": { "type": "boolean" }, "subscriptionLapsed": { "type": "boolean" }, "renewalIssueOnOwnSeat": { "type": "boolean" }, "renewalIssueOnMemberSeat": { "type": "boolean" }, "memberSeatPaymentFailed": { "type": "boolean" }, "memberSeatLapsed": { "type": "boolean" }, "isNewModelUser": { "type": "boolean" }, "newModelSignupEnabled": { "type": "boolean" }, "isActivationPending": { "type": "boolean" }, "modules": { "$ref": "#/components/schemas/PlanModuleSvcModel" }, "languageCapabilities": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageCapabilitySvcModel" } }, "learningSettings": { "$ref": "#/components/schemas/LearningSettingsSvcModel" }, "fluencyDrillSettings": { "$ref": "#/components/schemas/FluencyDrillSettingsSvcModel" } }, "additionalProperties": false }, "AuthenticateUserResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/AuthenticateUserResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "StringStringKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "readOnly": true }, "value": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "BiblingoAPIErrorResponse": { "type": "object", "properties": { "message": { "type": "string" }, "validationFailed": { "type": "boolean" }, "validationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringKeyValuePair" } } }, "additionalProperties": false }, "BiblingoAPIErrorResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/BiblingoAPIErrorResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AuthenticateUserRequest": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false }, "CampusEduTokenRequest": { "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false }, "AuthenticateCampusEduUserResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "rowId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "subscriptionPlan": { "enum": [ "Basic", "StandardOne", "StandardTwo", "Premium", "Free" ], "type": "string" }, "role": { "$ref": "#/components/schemas/GetRoleENUMResponse" }, "token": { "type": "string" }, "languages": { "type": "array", "items": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "courseID": { "type": "string" }, "courseLanguage": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "origin": { "type": "string" }, "lastLoginTime": { "type": "string", "format": "date-time", "nullable": true }, "universityOrOrganization": { "type": "boolean" }, "nativeLanguage": { "type": "boolean" }, "otherLanguages": { "type": "boolean" }, "whyAreYouStudying": { "type": "boolean" }, "yearsStudyingHebrew": { "type": "boolean" }, "yearsStudyingGreek": { "type": "boolean" }, "culture": { "type": "string" }, "modules": { "$ref": "#/components/schemas/PlanModuleSvcModel" }, "learningSettings": { "$ref": "#/components/schemas/LearningSettingsSvcModel" }, "fluencyDrillSettings": { "$ref": "#/components/schemas/FluencyDrillSettingsSvcModel" } }, "additionalProperties": false }, "AuthenticateCampusEduUserResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/AuthenticateCampusEduUserResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AuthenticateFullerUserRequest": { "type": "object", "properties": { "email": { "type": "string" }, "courseID": { "type": "string" }, "token": { "type": "string" } }, "additionalProperties": false }, "AuthenticateFullerUserResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "rowId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "subscriptionPlan": { "enum": [ "Basic", "StandardOne", "StandardTwo", "Premium", "Free" ], "type": "string" }, "role": { "$ref": "#/components/schemas/GetRoleENUMResponse" }, "token": { "type": "string" }, "languages": { "type": "array", "items": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "courseID": { "type": "string" }, "courseLanguage": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "origin": { "type": "string" }, "lastLoginTime": { "type": "string", "format": "date-time", "nullable": true }, "universityOrOrganization": { "type": "boolean" }, "nativeLanguage": { "type": "boolean" }, "otherLanguages": { "type": "boolean" }, "whyAreYouStudying": { "type": "boolean" }, "yearsStudyingHebrew": { "type": "boolean" }, "yearsStudyingGreek": { "type": "boolean" }, "culture": { "type": "string" }, "modules": { "$ref": "#/components/schemas/PlanModuleSvcModel" }, "learningSettings": { "$ref": "#/components/schemas/LearningSettingsSvcModel" }, "fluencyDrillSettings": { "$ref": "#/components/schemas/FluencyDrillSettingsSvcModel" } }, "additionalProperties": false }, "AuthenticateFullerUserResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/AuthenticateFullerUserResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateCustomerDetailsRequest": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "customerId": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "CreateSubscriptionDetailsRequest": { "type": "object", "properties": { "id": { "type": "string" }, "subscriptionStatus": { "type": "string" }, "subscriptionType": { "type": "string" }, "trialStart": { "type": "number", "format": "double" }, "trialEnd": { "type": "number", "format": "double" }, "createdAt": { "type": "number", "format": "double" }, "activatedAt": { "type": "number", "format": "double" }, "currentPlanEnd": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreateSignUpContentRequest": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CreateCustomerDetailsRequest" }, "subscription": { "$ref": "#/components/schemas/CreateSubscriptionDetailsRequest" } }, "additionalProperties": false }, "SignUpUserRequest": { "type": "object", "properties": { "content": { "$ref": "#/components/schemas/CreateSignUpContentRequest" }, "event": { "type": "string" }, "eventSource": { "type": "string" }, "eventSourceUser": { "type": "string" } }, "additionalProperties": false }, "StringStringValuesKeyValuePair": { "type": "object", "properties": { "key": { "type": "string", "readOnly": true }, "value": { "type": "array", "items": { "type": "string" }, "readOnly": true } }, "additionalProperties": false }, "SubscriptionItem": { "type": "object", "properties": { "itemPriceId": { "type": "string" }, "itemType": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "freeQuantity": { "type": "integer", "format": "int32" }, "billingCycles": { "type": "integer", "format": "int32" }, "object": { "type": "string" }, "chargeOnEvent": { "type": "string" }, "chargeOnce": { "type": "boolean" }, "trialEnd": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ItemTier": { "type": "object", "properties": { "itemPriceId": { "type": "string" }, "startingUnit": { "type": "integer", "format": "int32" }, "endingUnit": { "type": "integer", "format": "int32", "nullable": true }, "price": { "type": "number", "format": "double" }, "object": { "type": "string" } }, "additionalProperties": false }, "SubscriptionData": { "type": "object", "properties": { "billingPeriodUnit": { "type": "string" }, "status": { "type": "string" }, "currentTermStart": { "type": "integer", "format": "int64" }, "currentTermEnd": { "type": "integer", "format": "int64" }, "subscriptionItems": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionItem" } }, "trialStart": { "type": "integer", "format": "int64" }, "trialEnd": { "type": "integer", "format": "int64" }, "itemTiers": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTier" } }, "additionalAccountEmails": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CustomerData": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "customerId": { "type": "string" } }, "additionalProperties": false }, "CreateUpdateSubscriptionContentRequest": { "type": "object", "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionData" }, "customer": { "$ref": "#/components/schemas/CustomerData" }, "event": { "type": "string" } }, "additionalProperties": false }, "CreateUpdateSubscriptionRequest": { "type": "object", "properties": { "content": { "$ref": "#/components/schemas/CreateUpdateSubscriptionContentRequest" }, "eventSource": { "type": "string" }, "event": { "type": "string" } }, "additionalProperties": false }, "SetInitialPasswordRequest": { "type": "object", "properties": { "setInitialPasswordApiKey": { "type": "string" }, "email": { "type": "string" }, "newPassword": { "type": "string" }, "confirmPassword": { "type": "string" } }, "additionalProperties": false }, "ForgotPasswordRequest": { "type": "object", "properties": { "email": { "type": "string" }, "resetPasswordLinkURL": { "type": "string" } }, "additionalProperties": false }, "ForgotPasswordResponse": { "type": "object", "properties": { "resetId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ForgotPasswordResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/ForgotPasswordResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "ResetPasswordRequest": { "type": "object", "properties": { "token": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "newPassword": { "type": "string" }, "confirmPassword": { "type": "string" } }, "additionalProperties": false }, "ChangePasswordRequest": { "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" }, "confirmPassword": { "type": "string" } }, "additionalProperties": false }, "ChangeEmailRequest": { "type": "object", "properties": { "existingEmail": { "type": "string" }, "newEmail": { "type": "string" } }, "additionalProperties": false }, "ChangeStatusRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "active": { "type": "boolean" } }, "additionalProperties": false }, "UpdateLanguageRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "culture": { "type": "string" } }, "additionalProperties": false }, "GetTestamentResponse": { "type": "object", "properties": { "testament": { "enum": [ "Old", "New" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetTestamentResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetTestamentResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBooksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "shortName": { "type": "string" }, "fullName": { "type": "string" } }, "additionalProperties": false }, "GetBooksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBooksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChaptersResponse": { "type": "object", "properties": { "chapters": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "additionalProperties": false }, "GetChaptersResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChaptersResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BibleVerseWordSvcModel": { "type": "object", "properties": { "text": { "type": "string" }, "isAppend": { "type": "boolean" }, "isSegment": { "type": "boolean" }, "isPunctuation": { "type": "boolean" }, "strongsNumber": { "type": "string" }, "osisID": { "type": "string" }, "attributes": { "type": "string" }, "status": { "enum": [ "NotLearned", "SenseLearned", "MultipleSensesLearned", "AllSensesLearned", "Archived", "Unknown" ], "type": "string" } }, "additionalProperties": false }, "BibleVerseNumberSvcModel": { "type": "object", "properties": { "verse": { "type": "integer", "format": "int32" }, "isRead": { "type": "boolean" }, "readCount": { "type": "integer", "format": "int32" }, "words": { "type": "array", "items": { "$ref": "#/components/schemas/BibleVerseWordSvcModel" } } }, "additionalProperties": false }, "PronunciationSvcModel": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "GetVersesResponse": { "type": "object", "properties": { "bookId": { "type": "integer", "format": "int64" }, "shortName": { "type": "string" }, "fullName": { "type": "string" }, "chapter": { "type": "integer", "format": "int32" }, "percentage": { "type": "integer", "format": "int32" }, "readingPercentage": { "type": "integer", "format": "int32" }, "totalPoints": { "type": "integer", "format": "int64" }, "hasPrevious": { "type": "boolean" }, "hasNext": { "type": "boolean" }, "verses": { "type": "array", "items": { "$ref": "#/components/schemas/BibleVerseNumberSvcModel" } }, "audioFiles": { "type": "array", "items": { "$ref": "#/components/schemas/PronunciationSvcModel" } } }, "additionalProperties": false }, "GetVersesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetVersesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetWordOccurrencesTextResponse": { "type": "object", "properties": { "text": { "type": "string" }, "isHighlighted": { "type": "boolean" }, "isAppend": { "type": "boolean" }, "isSegment": { "type": "boolean" }, "isPunctuation": { "type": "boolean" } }, "additionalProperties": false }, "GetWordOccurrencesResponse": { "type": "object", "properties": { "book": { "type": "string" }, "bookId": { "type": "integer", "format": "int64" }, "chapter": { "type": "integer", "format": "int32" }, "verse": { "type": "integer", "format": "int32" }, "words": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordOccurrencesTextResponse" } } }, "additionalProperties": false }, "GetWordOccurrencesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetWordOccurrencesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetWordFrequenciesResponse": { "type": "object", "properties": { "frequency": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetWordFrequenciesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetWordFrequenciesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetRecentBookResponse": { "type": "object", "properties": { "bookId": { "type": "integer", "format": "int64" }, "shortName": { "type": "string" }, "fullName": { "type": "string" }, "chapter": { "type": "integer", "format": "int32" }, "percentage": { "type": "integer", "format": "int32" }, "readingPercentage": { "type": "integer", "format": "int32" }, "totalPoints": { "type": "integer", "format": "int64" }, "hasPrevious": { "type": "boolean" }, "hasNext": { "type": "boolean" }, "verses": { "type": "array", "items": { "$ref": "#/components/schemas/BibleVerseNumberSvcModel" } }, "audioFiles": { "type": "array", "items": { "$ref": "#/components/schemas/PronunciationSvcModel" } } }, "additionalProperties": false }, "GetRecentBookResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetRecentBookResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBookWisePercentageResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "book": { "type": "string" }, "chapters": { "type": "integer", "format": "int32" }, "percentage": { "type": "integer", "format": "int32" }, "readingPercentage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetBookWisePercentageResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBookWisePercentageResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChapterWisePercentageResponse": { "type": "object", "properties": { "book": { "type": "string" }, "bookId": { "type": "integer", "format": "int64" }, "chapter": { "type": "integer", "format": "int32" }, "percentage": { "type": "integer", "format": "int32" }, "readingPercentage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetChapterWisePercentageResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChapterWisePercentageResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UploadBookResponse": { "type": "object", "properties": { "chapters": { "type": "integer", "format": "int32" }, "verses": { "type": "integer", "format": "int32" }, "words": { "type": "integer", "format": "int32" }, "isSuccess": { "type": "boolean" }, "failedCount": { "type": "integer", "format": "int32" }, "failedEntries": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "UploadBookResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/UploadBookResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetWordResponse": { "type": "object", "properties": { "hebrewRoot": { "type": "string" }, "greekRoot": { "type": "string" }, "genN": { "type": "string" }, "plural": { "type": "string" }, "pluralConstruct": { "type": "string" }, "dual": { "type": "string" }, "dualConstruct": { "type": "string" }, "construct": { "type": "string" }, "adjForms": { "type": "string" }, "perfMid": { "type": "string" }, "perfect": { "type": "string" }, "future": { "type": "string" }, "futureMid": { "type": "string" }, "futurePasv": { "type": "string" }, "aorMid": { "type": "string" }, "aorPasv": { "type": "string" }, "aorist": { "type": "string" }, "imperfect": { "type": "string" }, "presMP": { "type": "string" }, "imperfectMP": { "type": "string" }, "nomFNAdj": { "type": "string" } }, "additionalProperties": false }, "GrammaticalFormsResponse": { "type": "object", "properties": { "yiqtol": { "type": "string" }, "qatal": { "type": "string" }, "wayyiqtol": { "type": "string" }, "weqatal": { "type": "string" }, "participle": { "type": "string" }, "imperative": { "type": "string" }, "jussive": { "type": "string" }, "cohortative": { "type": "string" }, "infinitiveConstruct": { "type": "string" }, "infinitiveAbsolute": { "type": "string" }, "genN": { "type": "string" }, "plural": { "type": "string" }, "pluralConstruct": { "type": "string" }, "dual": { "type": "string" }, "dualConstruct": { "type": "string" }, "construct": { "type": "string" }, "adjForms": { "type": "string" }, "perfMid": { "type": "string" }, "perfect": { "type": "string" }, "future": { "type": "string" }, "futureMid": { "type": "string" }, "futurePasv": { "type": "string" }, "aorMid": { "type": "string" }, "aorPasv": { "type": "string" }, "aorist": { "type": "string" }, "imperfect": { "type": "string" }, "presMP": { "type": "string" }, "imperfectMP": { "type": "string" }, "nomFNAdj": { "type": "string" } }, "additionalProperties": false }, "GetWordExampleResponse": { "type": "object", "properties": { "reference": { "type": "string" }, "verse": { "type": "string" } }, "additionalProperties": false }, "GetWordIllustrationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "caption": { "type": "string" } }, "additionalProperties": false }, "GetWordPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "senseNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetAddedDeckResponse": { "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "GetWordSenseResponse": { "type": "object", "properties": { "isArchived": { "type": "boolean" }, "isAddedToDeck": { "type": "boolean" }, "ishighlighted": { "type": "boolean" }, "isVoted": { "type": "boolean" }, "contentType": { "enum": [ "None", "PronunciationOnly", "IllustrationOnly", "Both" ], "type": "string" }, "senseID": { "type": "string" }, "grammaticalForms": { "$ref": "#/components/schemas/GrammaticalFormsResponse" }, "gloss": { "type": "string" }, "hebrewRoot": { "type": "string" }, "greekRoot": { "type": "string" }, "senseFormDictionary": { "type": "string" }, "definition": { "type": "string" }, "semanticDomain": { "type": "string" }, "gender": { "type": "string" }, "argumentRealizations": { "type": "string" }, "binyan": { "type": "string" }, "culturalInfo": { "type": "string" }, "category": { "type": "string" }, "votes": { "type": "integer", "format": "int64" }, "index": { "type": "integer", "format": "int32" }, "picSource": { "type": "string" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordExampleResponse" } }, "illustrations": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordIllustrationResponse" } }, "pronunciations": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordPronunciationResponse" } }, "decks": { "type": "array", "items": { "$ref": "#/components/schemas/GetAddedDeckResponse" } } }, "additionalProperties": false }, "GetSensesResponse": { "type": "object", "properties": { "isArchived": { "type": "boolean" }, "isVotingDisabled": { "type": "boolean" }, "word": { "$ref": "#/components/schemas/GetWordResponse" }, "senses": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordSenseResponse" } } }, "additionalProperties": false }, "GetSensesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSensesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "RosterFurthestLessonModel": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "label": { "type": "string" } }, "additionalProperties": false }, "LearnerStatCardModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "highestUnlockedLesson": { "type": "string" }, "highestUnlockedMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "highestUnlockedSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "weekXp": { "type": "integer", "format": "int32" }, "weekXpDelta": { "type": "integer", "format": "int32", "nullable": true }, "weekTimeMinutes": { "type": "integer", "format": "int32" }, "weekTimeDeltaMinutes": { "type": "integer", "format": "int32", "nullable": true }, "wpm": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ClassRoomRosterItemModel": { "type": "object", "properties": { "membershipId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "email": { "type": "string" }, "displayName": { "type": "string" }, "status": { "enum": [ "Active", "PendingPlaceholder", "Removed", "PendingApproval" ], "type": "string" }, "furthestLesson": { "$ref": "#/components/schemas/RosterFurthestLessonModel" }, "lastActiveAt": { "type": "string", "format": "date-time", "nullable": true }, "weekStats": { "$ref": "#/components/schemas/LearnerStatCardModel" } }, "additionalProperties": false }, "GetClassRoomRosterResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassRoomRosterItemModel" } }, "totalCount": { "type": "integer", "format": "int32" }, "weekStart": { "type": "string" }, "weekEnd": { "type": "string" } }, "additionalProperties": false }, "GetClassRoomRosterResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetClassRoomRosterResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateClassRoomRequest": { "type": "object", "properties": { "name": { "type": "string" }, "school": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "startMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "startSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "EditClassRoomRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "school": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "startMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "startSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RegenerateClassRoomCodeRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "RegenerateClassRoomCodeResponse": { "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false }, "RegenerateClassRoomCodeResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/RegenerateClassRoomCodeResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "ArchiveClassRoomRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "AddCoTeacherRequest": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "email": { "type": "string" } }, "additionalProperties": false }, "ClassRoomCoTeacherModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "email": { "type": "string" }, "displayName": { "type": "string" }, "status": { "enum": [ "Active", "PendingPlaceholder", "Removed", "PendingApproval" ], "type": "string" } }, "additionalProperties": false }, "ClassRoomOwnerModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "GetClassRoomCoTeachersResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ClassRoomCoTeacherModel" } }, "owner": { "$ref": "#/components/schemas/ClassRoomOwnerModel" } }, "additionalProperties": false }, "GetClassRoomCoTeachersResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetClassRoomCoTeachersResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AddClassRoomStudentRequest": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "emails": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AddClassRoomStudentResponse": { "type": "object", "properties": { "requested": { "type": "integer", "format": "int32" }, "invited": { "type": "integer", "format": "int32" }, "skipped": { "type": "integer", "format": "int32" }, "invalidEmails": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "AddClassRoomStudentResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/AddClassRoomStudentResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "PreviewAddStudentsRequest": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "emails": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "EmailPreviewItem": { "type": "object", "properties": { "email": { "type": "string" }, "status": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "PreviewAddStudentsResponse": { "type": "object", "properties": { "existingCount": { "type": "integer", "format": "int32" }, "unknownCount": { "type": "integer", "format": "int32" }, "alreadyMemberCount": { "type": "integer", "format": "int32" }, "alreadyPendingCount": { "type": "integer", "format": "int32" }, "invalidCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmailPreviewItem" } } }, "additionalProperties": false }, "PreviewAddStudentsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/PreviewAddStudentsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "ImportRowError": { "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "reason": { "type": "string" } }, "additionalProperties": false }, "ImportClassRoomStudentsResponse": { "type": "object", "properties": { "created": { "type": "integer", "format": "int32" }, "linkedToExisting": { "type": "integer", "format": "int32" }, "skipped": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRowError" } } }, "additionalProperties": false }, "ImportClassRoomStudentsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/ImportClassRoomStudentsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "JoinClassRoomByCodeRequest": { "type": "object", "properties": { "code": { "type": "string" }, "shareProgressWithClassmates": { "type": "boolean" } }, "additionalProperties": false }, "JoinClassRoomByCodeResponse": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "membershipId": { "type": "integer", "format": "int64" }, "classRoomName": { "type": "string" } }, "additionalProperties": false }, "JoinClassRoomByCodeResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/JoinClassRoomByCodeResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "PendingClassRequestResponse": { "type": "object", "properties": { "membershipId": { "type": "integer", "format": "int64" }, "classRoomId": { "type": "integer", "format": "int64" }, "className": { "type": "string" }, "school": { "type": "string" }, "language": { "type": "string" }, "teacherName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "startMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "startSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "endSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PendingClassRequestResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/PendingClassRequestResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AcceptClassRequestRequest": { "type": "object", "properties": { "membershipId": { "type": "integer", "format": "int64" }, "shareProgressWithClassmates": { "type": "boolean" } }, "additionalProperties": false }, "ClassmateCardModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "stats": { "$ref": "#/components/schemas/LearnerStatCardModel" } }, "additionalProperties": false }, "GetClassmatesResponse": { "type": "object", "properties": { "totalActive": { "type": "integer", "format": "int32" }, "sharingCount": { "type": "integer", "format": "int32" }, "viewerIsSharing": { "type": "boolean" }, "you": { "$ref": "#/components/schemas/ClassmateCardModel" }, "classmates": { "type": "array", "items": { "$ref": "#/components/schemas/ClassmateCardModel" } } }, "additionalProperties": false }, "GetClassmatesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetClassmatesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SetShareProgressRequest": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "share": { "type": "boolean" } }, "additionalProperties": false }, "DeclineClassRequestRequest": { "type": "object", "properties": { "membershipId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "MapStudentToClassRoomRequest": { "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveStreakResponse": { "type": "object", "properties": { "currentStreakInDays": { "type": "integer", "format": "int64" }, "currentStreakPercentage": { "type": "integer", "format": "int32" }, "isCurrentPercentageIncrease": { "type": "boolean" }, "longestStreakInDays": { "type": "integer", "format": "int64" }, "longestStreakPercentage": { "type": "integer", "format": "int32" }, "isLongestPercentageIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveStreakResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveStreakResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveDaysSpentOverviewResponse": { "type": "object", "properties": { "numberOfDaysSpent": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveDaysSpentOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveDaysSpentOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectivePointAccumulatedOverviewResponse": { "type": "object", "properties": { "pointsAccumulated": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectivePointAccumulatedOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectivePointAccumulatedOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSessionOverviewResponse": { "type": "object", "properties": { "numberOfSessions": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveSessionOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveSessionOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTimeOverviewResponse": { "type": "object", "properties": { "totalTimeTakenInMs": { "type": "number", "format": "double" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" }, "totalTimeTaken": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "GetCollectiveTimeOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveTimeOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByBibleReadingResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByBibleReadingResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByBibleReadingResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByFlashCardResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByFlashCardResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveDaysSpentByLanguageLearningResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveDaysSpentByLanguageLearningResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectivePointChartByBibleReadingResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectivePointChartByBibleReadingResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectivePointChartByBibleReadingResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectivePointChartByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectivePointChartByFlashCardResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectivePointChartByFlashCardResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectivePointChartByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectivePointChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectivePointChartByLanguageLearningResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSessionByBibleReadingResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveSessionByBibleReadingResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveSessionByBibleReadingResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSessionByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveSessionByFlashCardResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveSessionByFlashCardResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSessionByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveSessionByLanguageLearningResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveSessionByLanguageLearningResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByBibleReadingResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByBibleReadingResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByBibleReadingResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByFlashCardResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByFlashCardResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveTimeSpentChartByLanguageLearningResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveTimeSpentChartByLanguageLearningResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedOverviewResponse": { "type": "object", "properties": { "numberOfWordsLearned": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveVocabProficiencyOverviewResponse": { "type": "object", "properties": { "proficiencyPercentage": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveVocabProficiencyOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveVocabProficiencyOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByBibleReadingResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByBibleReadingResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByBibleReadingResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByFlashCardResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByFlashCardResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveWordsLearnedByLanguageLearningResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveWordsLearnedByLanguageLearningResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveProficiencyByFlashCardResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveProficiencyByFlashCardResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveProficiencyByFlashCardResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveProficiencyByLanguageLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveProficiencyByLanguageLearningResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveProficiencyByLanguageLearningResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveProficiencyOverviewResponse": { "type": "object", "properties": { "correctAnswerPercentage": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveProficiencyOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveProficiencyOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSentenceOverviewResponse": { "type": "object", "properties": { "numberOfSentencesPracticed": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveSentenceOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveSentenceOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTopicOverviewResponse": { "type": "object", "properties": { "numberOfTopicsLearned": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveTopicOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveTopicOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveProficiencyChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetCollectiveProficiencyChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveProficiencyChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveSentenceChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveSentenceChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveSentenceChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveTopicChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveTopicChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveTopicChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveBookOverviewResponse": { "type": "object", "properties": { "numberOfBooksCompleted": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveBookOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveBookOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveChapterOverviewResponse": { "type": "object", "properties": { "numberOfChaptersCompleted": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetCollectiveChapterOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveChapterOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveBookLineChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveBookLineChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveBookLineChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveBookRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveBookRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveBookRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveChapterLineChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveChapterLineChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCollectiveChapterLineChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveChapterRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveChapterRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveChapterRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCollectiveWordRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetCollectiveWordRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCollectiveWordRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCountriesResponse": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "GetCountriesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetCountriesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCoursesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "courseID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "isBibleReading": { "type": "boolean" }, "isFlashCardDeck": { "type": "boolean" }, "isLanguageLearning": { "type": "boolean" }, "isAlphabetDeckLearning": { "type": "boolean" }, "isVideoTutorials": { "type": "boolean" } }, "additionalProperties": false }, "GetCoursesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCoursesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AddWordToCustomDeckRequest": { "type": "object", "properties": { "name": { "type": "string" }, "group": { "type": "string" }, "senseID": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "SeedUpdateDataRequest": { "type": "object", "additionalProperties": false }, "EnumResponseSvcModel": { "type": "object", "properties": { "value": { "type": "object" }, "description": { "type": "string" } }, "additionalProperties": false }, "LessonPointSvcModel": { "type": "object", "properties": { "point": { "type": "number", "format": "double" }, "description": { "type": "string" } }, "additionalProperties": false }, "LessonBadgeSvcModel": { "type": "object", "properties": { "name": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/LessonPointSvcModel" } } }, "additionalProperties": false }, "PointBadgeSvcModel": { "type": "object", "properties": { "points": { "type": "number", "format": "double" }, "badge": { "type": "string" } }, "additionalProperties": false }, "LessonGuideSvcModel": { "type": "object", "properties": { "mainLessonNumber": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "filePath": { "type": "string" }, "mediaType": { "enum": [ "Image", "Video", "Audio", "Document", "Unknown" ], "type": "string" } }, "additionalProperties": false }, "CompletedActivitySvcModel": { "type": "object", "properties": { "isStageCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "activityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" }, "levelNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActivityPointsRewardSvcModel": { "type": "object", "properties": { "pointsCategory": { "enum": [ "Learn", "Retain", "Fluency" ], "type": "string" }, "pointsEarned": { "type": "integer", "format": "int32" }, "runningWeeklyPointsInCategory": { "type": "integer", "format": "int32" }, "correctAnswerCount": { "type": "integer", "format": "int32" }, "incorrectAnswerCount": { "type": "integer", "format": "int32" }, "bonusPointsCategory": { "enum": [ "NotYetCompleted", "None", "Smart", "Genius", "Fast", "Lightning" ], "type": "string" }, "bonusPointsEarned": { "type": "integer", "format": "int32" }, "previouslyCompletedCount": { "type": "integer", "format": "int32" }, "bestRunningTimeInMilliseconds": { "type": "integer", "format": "int64", "nullable": true }, "bestPercentCorrect": { "type": "number", "format": "double", "nullable": true }, "bestWordsPerMinute": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyDeckAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyDeckAnswerRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyDeckAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyDeckAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyDeckAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyDeckAnswerResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyDeckAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyDeckAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyDeckAnswerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyDeckAnswerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "PreviousDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "PreviousDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/PreviousDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BackToDeckAssociationResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "BackToDeckAssociationResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/BackToDeckAssociationResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BackToDeckLearningResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "BackToDeckLearningResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/BackToDeckLearningResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDeckGroupsResponse": { "type": "object", "properties": { "group": { "type": "string" }, "displayGroup": { "type": "string" }, "isShared": { "type": "boolean" }, "isCustomDeck": { "type": "boolean", "nullable": true }, "isGenerated": { "type": "boolean", "nullable": true }, "sharedByUserID": { "type": "integer", "format": "int64", "nullable": true }, "sharedByUser": { "type": "string" } }, "additionalProperties": false }, "GetDeckGroupsResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetDeckGroupsResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDeckOverviewResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "deckType": { "enum": [ "Lesson", "Preset", "Custom", "WordsNeedPractise" ], "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "group": { "type": "string" }, "name": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "displayLessonNumber": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isGenerated": { "type": "boolean" }, "isCustomDeck": { "type": "boolean" }, "isSharedByUser": { "type": "boolean" }, "sharedByUserID": { "type": "integer", "format": "int64", "nullable": true }, "sharedByUser": { "type": "string" }, "hasWords": { "type": "boolean" }, "words": { "type": "array", "items": { "type": "string" } }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetDeckOverviewResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetDeckOverviewResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDeckLevelStatusResponse": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "percentCompleted": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetStageENUMResponse": { "type": "object", "properties": { "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetLessonStageResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "isNavigatable": { "type": "boolean" }, "stage": { "$ref": "#/components/schemas/GetStageENUMResponse" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetDeckStatusResponse": { "type": "object", "properties": { "level": { "$ref": "#/components/schemas/GetDeckLevelStatusResponse" }, "vocabulary": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonStageResponse" } } }, "additionalProperties": false }, "GetDeckStatusResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDeckStatusResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDeckResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetDeckResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDeckResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDeckStageResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetDeckStageResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDeckStageResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextExerciseRecommendationSvcModel": { "type": "object", "properties": { "todoType": { "enum": [ "Alphabet", "Lesson", "VocabPractice" ], "type": "string" }, "activityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string" }, "id": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64", "nullable": true }, "displayName": { "type": "string" }, "availablePoints": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetNextExerciseRecommendationsResponse": { "type": "object", "properties": { "recommendationsByPointsCategory": { "type": "object", "properties": { "Learn": { "type": "array", "items": { "$ref": "#/components/schemas/NextExerciseRecommendationSvcModel" } }, "Retain": { "type": "array", "items": { "$ref": "#/components/schemas/NextExerciseRecommendationSvcModel" } }, "Fluency": { "type": "array", "items": { "$ref": "#/components/schemas/NextExerciseRecommendationSvcModel" } } } }, "prioritizedPointsCategories": { "type": "array", "items": { "enum": [ "Learn", "Retain", "Fluency" ], "type": "string" } } }, "additionalProperties": false }, "GetNextExerciseRecommendationsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetNextExerciseRecommendationsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "FamilyFurthestLessonModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "level": { "type": "integer", "format": "int32" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "label": { "type": "string" } }, "additionalProperties": false }, "FamilyMemberModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "furthestLesson": { "$ref": "#/components/schemas/FamilyFurthestLessonModel" } }, "additionalProperties": false }, "GetFamilyMembersResponse": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/FamilyMemberModel" } } }, "additionalProperties": false }, "GetFamilyMembersResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFamilyMembersResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "ClassProgressModel": { "type": "object", "properties": { "furthestMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "furthestSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "furthestLabel": { "type": "string" }, "lastLessonLabel": { "type": "string" }, "progressPercent": { "type": "integer", "format": "int32" }, "expectedMainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "expectedSubLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "expectedLabel": { "type": "string" } }, "additionalProperties": false }, "ClassLessonModeStatsModel": { "type": "object", "properties": { "atOrAbove": { "type": "integer", "format": "int32" }, "below": { "type": "integer", "format": "int32" }, "notAttempted": { "type": "integer", "format": "int32" }, "average": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ClassLessonModesModel": { "type": "object", "properties": { "learn": { "$ref": "#/components/schemas/ClassLessonModeStatsModel" }, "retain": { "$ref": "#/components/schemas/ClassLessonModeStatsModel" }, "fluency": { "$ref": "#/components/schemas/ClassLessonModeStatsModel" } }, "additionalProperties": false }, "ClassLessonRowModel": { "type": "object", "properties": { "journey": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "subGroup": { "type": "string" }, "modes": { "$ref": "#/components/schemas/ClassLessonModesModel" } }, "additionalProperties": false }, "GetFamilyLessonsResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "content": { "enum": [ "Words", "Sentences", "Stories", "Alphabet" ], "type": "string" }, "benchmark": { "type": "integer", "format": "int32" }, "totalMembers": { "type": "integer", "format": "int32" }, "progress": { "$ref": "#/components/schemas/ClassProgressModel" }, "lessons": { "type": "array", "items": { "$ref": "#/components/schemas/ClassLessonRowModel" } } }, "additionalProperties": false }, "GetFamilyLessonsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFamilyLessonsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDeckSettingsResponse": { "type": "object", "properties": { "defaultDisplayField": { "enum": [ "Gloss", "Definition" ], "type": "string" }, "wordsPerDeck": { "type": "integer", "format": "int32" }, "initialStageOfReview": { "enum": [ "Association", "PassiveEasy", "PassiveHard", "Active" ], "type": "string" }, "displayArchivedWords": { "type": "boolean" } }, "additionalProperties": false }, "GetFlashCardDeckSettingsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFlashCardDeckSettingsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDecksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "groupId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "isSharedByUser": { "type": "boolean" }, "sharedByUser": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDecksResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetFlashCardDecksResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDeckGroupsResponse": { "type": "object", "properties": { "groupID": { "type": "integer", "format": "int64" }, "group": { "type": "string" }, "isShared": { "type": "boolean" } }, "additionalProperties": false }, "GetFlashCardDeckGroupsResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetFlashCardDeckGroupsResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDeckEntriesExampleResponse": { "type": "object", "properties": { "reference": { "type": "string" }, "verse": { "type": "string" } }, "additionalProperties": false }, "GetFlashCardDeckEntriesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "senseID": { "type": "string" }, "text": { "type": "string" }, "isNewlyAdded": { "type": "boolean" }, "gloss": { "type": "string" }, "definition": { "type": "string" }, "audioFilePath": { "type": "string" }, "illustrationFilePath": { "type": "string" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/GetFlashCardDeckEntriesExampleResponse" } } }, "additionalProperties": false }, "GetFlashCardDeckEntriesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetFlashCardDeckEntriesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSemanticDomainEntriesResponse": { "type": "object", "properties": { "text": { "type": "string" }, "gloss": { "type": "string" }, "semanticDomain": { "type": "string" }, "senseID": { "type": "string" } }, "additionalProperties": false }, "GetSemanticDomainEntriesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetSemanticDomainEntriesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SearchWordsForDeckExampleResponse": { "type": "object", "properties": { "reference": { "type": "string" }, "verse": { "type": "string" } }, "additionalProperties": false }, "SearchWordsForDeckResponse": { "type": "object", "properties": { "entryRefId": { "type": "string" }, "senseID": { "type": "string" }, "word": { "type": "string" }, "gloss": { "type": "string" }, "definition": { "type": "string" }, "audioFilePath": { "type": "string" }, "illustrationFilePath": { "type": "string" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/SearchWordsForDeckExampleResponse" } } }, "additionalProperties": false }, "SearchWordsForDeckResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/SearchWordsForDeckResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AddFlashCardDeckRequest": { "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "AddFlashCardDeckEntryAudioFileRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "AddFlashCardDeckEntryIllustrationFileRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "AddFlashCardDeckEntryExampleRequest": { "type": "object", "properties": { "reference": { "type": "string" }, "verse": { "type": "string" } }, "additionalProperties": false }, "AddFlashCardDeckEntryRequest": { "type": "object", "properties": { "deckId": { "type": "integer", "format": "int64" }, "entryRefId": { "type": "string" }, "senseId": { "type": "string" }, "text": { "type": "string" }, "gloss": { "type": "string" }, "definition": { "type": "string" }, "audio": { "$ref": "#/components/schemas/AddFlashCardDeckEntryAudioFileRequest" }, "illustration": { "$ref": "#/components/schemas/AddFlashCardDeckEntryIllustrationFileRequest" }, "example": { "$ref": "#/components/schemas/AddFlashCardDeckEntryExampleRequest" } }, "additionalProperties": false }, "GenerateDeckByBibleReadingRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "groupName": { "type": "string" }, "deckName": { "type": "string" }, "sensesToInclude": { "enum": [ "FirstSenseOfAllWords", "FirstUnknownSense", "AllUnknownSenses" ], "type": "string" }, "startFromBookID": { "type": "integer", "format": "int64" }, "finishUpToBookID": { "type": "integer", "format": "int64" }, "fromChapter": { "type": "integer", "format": "int32" }, "toChapter": { "type": "integer", "format": "int32" }, "wordsPerDeck": { "type": "integer", "format": "int32" }, "frequency": { "type": "integer", "format": "int32", "nullable": true }, "frequencyType": { "enum": [ "GreaterThan", "LessThan", "Range" ], "type": "string" }, "upperFrequency": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GenerateDeckBySemanticDomainRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "groupName": { "type": "string" }, "deckName": { "type": "string" }, "senseIDs": { "type": "string" }, "sensesToInclude": { "enum": [ "FirstSenseOfAllWords", "FirstUnknownSense", "AllUnknownSenses" ], "type": "string" }, "wordsPerDeck": { "type": "integer", "format": "int32" }, "frequency": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "EditFlashCardDeckEntryFileRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "EditFlashCardDeckEntryRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "mediaType": { "enum": [ "Image", "Video", "Audio", "Document", "Unknown" ], "type": "string" }, "file": { "$ref": "#/components/schemas/EditFlashCardDeckEntryFileRequest" } }, "additionalProperties": false }, "UpdateFlashCardDeckSettingsRequest": { "type": "object", "properties": { "defaultDisplayField": { "enum": [ "Gloss", "Definition" ], "type": "string" }, "wordsPerDeck": { "type": "integer", "format": "int32" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "initialStageOfReview": { "enum": [ "Association", "PassiveEasy", "PassiveHard", "Active" ], "type": "string", "nullable": true }, "displayArchivedWords": { "type": "boolean" } }, "additionalProperties": false }, "MoveFlashCardDeckRequest": { "type": "object", "properties": { "currentGroupID": { "type": "integer", "format": "int64" }, "newGroupID": { "type": "integer", "format": "int64" }, "deckID": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "ShareFlashCardDeckRequest": { "type": "object", "properties": { "shareDeckByParam": { "type": "string" }, "shareDeckByType": { "enum": [ "ClassroomCode", "Email" ], "type": "string" }, "deckID": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "GetFluencyDrillResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetFluencyDrillResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFluencyDrillResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifiFluencyDrillAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyFluencyDrillAnswerRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifiFluencyDrillAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyFluencyDrillAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyFluencyDrillAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyFluencyDrillAnswerResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyFluencyDrillAnswerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyFluencyDrillAnswerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipFluencyDrillActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipFluencyDrillActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipFluencyDrillActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextFluencyDrillActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextFluencyDrillActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextFluencyDrillActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLessonFluencyDrillDecksNameResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isArchived": { "type": "boolean" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "bestLearnPercentCorrect": { "type": "number", "format": "double", "nullable": true }, "bestLearnRunningTimeInMilliseconds": { "type": "integer", "format": "int64", "nullable": true }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetLessonFluencyDrillDecksResponse": { "type": "object", "properties": { "lessonNumber": { "type": "integer", "format": "int32" }, "decks": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonFluencyDrillDecksNameResponse" } } }, "additionalProperties": false }, "GetLessonFluencyDrillDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonFluencyDrillDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetOtherFluencyDrillDecksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isArchived": { "type": "boolean" }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetOtherFluencyDrillDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetOtherFluencyDrillDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetPracticeFluencyDrillDecksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "deckType": { "enum": [ "Lesson", "Other" ], "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isArchived": { "type": "boolean" } }, "additionalProperties": false }, "GetPracticeFluencyDrillDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPracticeFluencyDrillDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFluencyDrillDeckResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetFluencyDrillDeckResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFluencyDrillDeckResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAnswerRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAnswerResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyFluencyDrillDeckAnswerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyFluencyDrillDeckAnswerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipFluencyDrillDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipFluencyDrillDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipFluencyDrillDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextFluencyDrillDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextFluencyDrillDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextFluencyDrillDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetFluencyDrillSettingsResponse": { "type": "object", "properties": { "numberOfQuestions": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetFluencyDrillSettingsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFluencyDrillSettingsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UpdateFluencyDrillSettingsRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "numberOfQuestions": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FriendCardModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "isFamily": { "type": "boolean" }, "youFollowThem": { "type": "boolean" }, "followsYou": { "type": "boolean" }, "followsYouSince": { "type": "string", "format": "date-time", "nullable": true }, "currentLesson": { "type": "string" }, "stats": { "$ref": "#/components/schemas/LearnerStatCardModel" } }, "additionalProperties": false }, "FriendCardModelIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/FriendCardModel" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBlockedRequest": { "type": "object", "additionalProperties": false }, "BlockedUserModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "BlockedUserModelIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/BlockedUserModel" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "IncomingFollowRequestModel": { "type": "object", "properties": { "followId": { "type": "integer", "format": "int64" }, "requester": { "$ref": "#/components/schemas/FriendCardModel" } }, "additionalProperties": false }, "IncomingFollowRequestModelIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/IncomingFollowRequestModel" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SearchFriendResponse": { "type": "object", "properties": { "found": { "type": "boolean" }, "user": { "$ref": "#/components/schemas/FriendCardModel" }, "relationStatus": { "type": "string" } }, "additionalProperties": false }, "SearchFriendResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SearchFriendResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "RequestFollowRequest": { "type": "object", "properties": { "followeeId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "AcceptFollowRequest": { "type": "object", "properties": { "followId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "AcceptFollowResponse": { "type": "object", "properties": { "followerId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "youFollowThem": { "type": "boolean" }, "followBackIsImmediate": { "type": "boolean" } }, "additionalProperties": false }, "AcceptFollowResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/AcceptFollowResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "FollowBackRequest": { "type": "object", "properties": { "followerId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "FollowBackResponse": { "type": "object", "properties": { "autoAccepted": { "type": "boolean" }, "relationStatus": { "type": "string" } }, "additionalProperties": false }, "FollowBackResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/FollowBackResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "IgnoreFollowRequest": { "type": "object", "properties": { "followId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UnfollowRequest": { "type": "object", "properties": { "followeeId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "RemoveFollowerRequest": { "type": "object", "properties": { "followerId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "allLanguages": { "type": "boolean" } }, "additionalProperties": false }, "RemoveFollowerResponse": { "type": "object", "properties": { "removedCount": { "type": "integer", "format": "int32" }, "remainingLanguages": { "type": "array", "items": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } } }, "additionalProperties": false }, "RemoveFollowerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/RemoveFollowerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BlockUserRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UnblockUserRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "EnrollFullerUserRequest": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "courseID": { "type": "string" } }, "additionalProperties": false }, "DeleteFullerUserRequest": { "type": "object", "properties": { "email": { "type": "string" }, "courseID": { "type": "string" } }, "additionalProperties": false }, "UploadGrammarResponse": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "fileName": { "type": "string" }, "isSuccess": { "type": "boolean" }, "successEntryCount": { "type": "integer", "format": "int32" }, "failedCount": { "type": "integer", "format": "int32" }, "successEntries": { "type": "array", "items": { "type": "string" } }, "failedEntries": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "UploadGrammarResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/UploadGrammarResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "MapResourceRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "MapResourceLocalizationRequestFile": { "type": "object", "properties": { "culture": { "type": "string" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "MapResourceLocalizationRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/MapResourceLocalizationRequestFile" } } }, "additionalProperties": false }, "GetCountryResponse": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false }, "GetHebrewPronunciationResponse": { "type": "object", "properties": { "pronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "description": { "type": "string" } }, "additionalProperties": false }, "GetGreekPronunciationResponse": { "type": "object", "properties": { "pronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "description": { "type": "string" } }, "additionalProperties": false }, "GetUserLanguageResponse": { "type": "object", "properties": { "language": { "$ref": "#/components/schemas/GetLanguageENUMResponse" }, "hebrewPronunciation": { "$ref": "#/components/schemas/GetHebrewPronunciationResponse" }, "greekPronunciation": { "$ref": "#/components/schemas/GetGreekPronunciationResponse" }, "experienceInSpeaking": { "type": "string" }, "experienceInTeaching": { "type": "string" } }, "additionalProperties": false }, "GetUserResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "$ref": "#/components/schemas/GetRoleENUMResponse" }, "city": { "type": "string" }, "state": { "type": "string" }, "phoneNumber": { "type": "string" }, "country": { "$ref": "#/components/schemas/GetCountryResponse" }, "address": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/GetUserLanguageResponse" } }, "classRoomCodes": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "GetUserResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetUserResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateUserLanguageRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "experienceInSpeaking": { "type": "string" }, "experienceInTeaching": { "type": "string" } }, "additionalProperties": false }, "CreateUserRequest": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "role": { "enum": [ "Admin", "InternalTeacher", "ExternalTeacher", "Student", "Thirdparty" ], "type": "string" }, "resetPasswordLinkURL": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/CreateUserLanguageRequest" } } }, "additionalProperties": false }, "EditUserLanguageRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciationType": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "experienceInSpeaking": { "type": "string" }, "experienceInTeaching": { "type": "string" } }, "additionalProperties": false }, "EditUserRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "role": { "enum": [ "Admin", "InternalTeacher", "ExternalTeacher", "Student", "Thirdparty" ], "type": "string" }, "resetPasswordLinkURL": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/EditUserLanguageRequest" } } }, "additionalProperties": false }, "GetPointsResponse": { "type": "object", "properties": { "points": { "type": "integer", "format": "int32" }, "badge": { "type": "string" } }, "additionalProperties": false }, "GetPointsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPointsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetReasonsResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reason": { "type": "string" } }, "additionalProperties": false }, "GetReasonsResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetReasonsResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLearningSettingsResponse": { "type": "object", "properties": { "isPracticePopupEnabled": { "type": "boolean" }, "weeklyPointGoal": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLearningSettingsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLearningSettingsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UpdateLearningSettingsRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "isPracticePopupEnabled": { "type": "boolean" }, "weeklyPointGoal": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyAnswerRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyAnswerResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyAnswerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyAnswerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SpellCheckRequest": { "type": "object", "properties": { "userInput": { "type": "string" }, "correctAnswer": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "SpellCheckResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "SpellCheckResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/SpellCheckResultResponse" } }, "correctAnswers": { "type": "string" } }, "additionalProperties": false }, "SpellCheckResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SpellCheckResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "PreviousActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "PreviousActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/PreviousActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BackToAssociationResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "BackToAssociationResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/BackToAssociationResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "BackToLearningResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "BackToLearningResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/BackToLearningResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetAvatarResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "GetActivityStageResponse": { "type": "object", "properties": { "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false }, "GetOverviewLessonResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "level": { "type": "integer", "format": "int32" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "topic": { "type": "string" }, "name": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "vocabularyStage": { "$ref": "#/components/schemas/GetActivityStageResponse" }, "grammarStage": { "$ref": "#/components/schemas/GetActivityStageResponse" }, "finalActStage": { "$ref": "#/components/schemas/GetActivityStageResponse" }, "isHavingFluencyDrill": { "type": "boolean" }, "isFluencyDrillEnabled": { "type": "boolean" }, "fluencyDrillStatus": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isHavingReadingComprehension": { "type": "boolean" }, "isReadingComprehensionEnabled": { "type": "boolean" }, "readingComprehensionStatus": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" } }, "additionalProperties": false }, "GetOverviewLevelResponse": { "type": "object", "properties": { "avatar": { "$ref": "#/components/schemas/GetAvatarResponse" }, "level": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "percentCompleted": { "type": "integer", "format": "int32" }, "isCurrent": { "type": "boolean" }, "lessons": { "type": "array", "items": { "$ref": "#/components/schemas/GetOverviewLessonResponse" } } }, "additionalProperties": false }, "GetOverviewResponse": { "type": "object", "properties": { "notStarted": { "type": "integer", "format": "int32" }, "inProgress": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/GetOverviewLevelResponse" } }, "isAllTestsPassed": { "type": "boolean" } }, "additionalProperties": false }, "GetOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetOverviewSlimLessonResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "level": { "type": "integer", "format": "int32" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "topic": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" } }, "additionalProperties": false }, "GetOverviewSlimLevelResponse": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "percentCompleted": { "type": "integer", "format": "int32" }, "isCurrent": { "type": "boolean" }, "lessons": { "type": "array", "items": { "$ref": "#/components/schemas/GetOverviewSlimLessonResponse" } } }, "additionalProperties": false }, "GetOverviewSlimResponse": { "type": "object", "properties": { "notStarted": { "type": "integer", "format": "int32" }, "inProgress": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "levels": { "type": "array", "items": { "$ref": "#/components/schemas/GetOverviewSlimLevelResponse" } }, "isAllTestsPassed": { "type": "boolean" } }, "additionalProperties": false }, "GetOverviewSlimResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetOverviewSlimResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLessonsForUserResponse": { "type": "object", "properties": { "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLessonsForUserResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonsForUserResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "AvailableActivityPoints": { "type": "object", "properties": { "pointsCategory": { "enum": [ "Learn", "Retain", "Fluency" ], "type": "string" }, "pointsEarned": { "type": "integer", "format": "int32" }, "runningWeeklyPointsInCategory": { "type": "integer", "format": "int32" }, "correctAnswerCount": { "type": "integer", "format": "int32" }, "incorrectAnswerCount": { "type": "integer", "format": "int32" }, "bonusPointsCategory": { "enum": [ "NotYetCompleted", "None", "Smart", "Genius", "Fast", "Lightning" ], "type": "string" }, "bonusPointsEarned": { "type": "integer", "format": "int32" }, "previouslyCompletedCount": { "type": "integer", "format": "int32" }, "bestRunningTimeInMilliseconds": { "type": "integer", "format": "int64", "nullable": true }, "bestPercentCorrect": { "type": "number", "format": "double", "nullable": true }, "bestWordsPerMinute": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetLessonLevelStatusResponse": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "percentCompleted": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetGrammarStagesResponse": { "type": "object", "properties": { "topic": { "type": "string" }, "stages": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonStageResponse" } } }, "additionalProperties": false }, "LearningDeckResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" } }, "additionalProperties": false }, "LearningDeckPointsRewardSvcModel": { "type": "object", "properties": { "learningDeckId": { "type": "integer", "format": "int64" }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "LessonAvailablePointsByActivitySvcModel": { "type": "object", "properties": { "learningDecks": { "type": "array", "items": { "$ref": "#/components/schemas/LearningDeckPointsRewardSvcModel" } }, "vocabularyActivityAvailablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "grammarActivityAvailablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "patternDrillActivityAvailablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "storyActivityAvailablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "challengeActivityAvailablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetLessonStatusResponse": { "type": "object", "properties": { "lessonId": { "type": "integer", "format": "int64" }, "isHavingFluencyDrill": { "type": "boolean" }, "isFluencyDrillEnabled": { "type": "boolean" }, "fluencyDrillStatus": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isHavingReadingComprehension": { "type": "boolean" }, "isReadingComprehensionEnabled": { "type": "boolean" }, "isGrammarEnabled": { "type": "boolean" }, "isFinalActEnabled": { "type": "boolean" }, "readingComprehensionStatus": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "availableReadingComprehensionPoints": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableActivityPoints" } }, "level": { "$ref": "#/components/schemas/GetLessonLevelStatusResponse" }, "vocabulary": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonStageResponse" } }, "grammar": { "type": "array", "items": { "$ref": "#/components/schemas/GetGrammarStagesResponse" } }, "finalAct": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonStageResponse" } }, "alphabetLearningDecks": { "type": "array", "items": { "$ref": "#/components/schemas/LearningDeckResponse" } }, "availablePoints": { "$ref": "#/components/schemas/LessonAvailablePointsByActivitySvcModel" } }, "additionalProperties": false }, "GetLessonStatusResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonStatusResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLessonResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetLessonResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "ProgressLessonRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetStageResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isLevelCompleted": { "type": "boolean" }, "isPhaseCompleted": { "type": "boolean" }, "isTopicCompleted": { "type": "boolean" }, "isStageCompleted": { "type": "boolean" }, "isSubLessonCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isLevelEnd": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextDeckId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToAssociationEnabled": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32", "nullable": true }, "incorrectAnswers": { "type": "integer", "format": "int32", "nullable": true }, "badge": { "$ref": "#/components/schemas/LessonBadgeSvcModel" }, "points": { "$ref": "#/components/schemas/PointBadgeSvcModel" }, "guide": { "$ref": "#/components/schemas/LessonGuideSvcModel" }, "achievementBadgeFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetStageResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetStageResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLessonStageLastCompletedResponse": { "type": "object", "properties": { "lessonNumber": { "type": "integer", "format": "int32" }, "lessonStage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLessonStageLastCompletedResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonStageLastCompletedResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetCulturesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "GetCulturesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetCulturesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetResourcesResponse": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "GetResourcesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetResourcesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateCultureRequest": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "RenameMediaRequest": { "type": "object", "properties": { "oldFileName": { "type": "string" }, "newFileName": { "type": "string" } }, "additionalProperties": false }, "DeleteMediaRequest": { "type": "object", "properties": { "fileKey": { "type": "string" }, "fileKeys": { "type": "array", "items": { "type": "string" } }, "mediaType": { "enum": [ "Image", "Video", "Audio", "Document", "Unknown" ], "type": "string", "nullable": true }, "deleteAll": { "type": "boolean" } }, "additionalProperties": false }, "GetPlacementTestResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "isReattempt": { "type": "boolean" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "nextLessonNumber": { "type": "integer", "format": "int32" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "hasPrevious": { "type": "boolean" } }, "additionalProperties": false }, "GetPlacementTestResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPlacementTestResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextPlacementTestActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isLessonCompleted": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "isReattempt": { "type": "boolean" }, "lessonId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "nextLessonNumber": { "type": "integer", "format": "int32" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "hasPrevious": { "type": "boolean" } }, "additionalProperties": false }, "NextPlacementTestActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextPlacementTestActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyPlacementTestAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyPlacementTestAnswerRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyPlacementTestAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyPlacementTestAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyPlacementTestAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyPlacementTestAnswerResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyPlacementTestAnswerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyPlacementTestAnswerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetReadingRangeResponse": { "type": "object", "properties": { "chapters": { "type": "integer", "format": "int32" }, "verses": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetReadingRangeResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetReadingRangeResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateLessonPlanRequest": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "name": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "pace": { "type": "integer", "format": "int32" }, "daysOfWeek": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PlanModuleRequest": { "type": "object", "properties": { "moduleType": { "enum": [ "CustomDeck", "BibleReading", "FluencyDrill", "WordsThatNeedPractice" ], "type": "string" }, "pace": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreatePracticeGoalsPlanRequest": { "type": "object", "properties": { "name": { "type": "string" }, "planModules": { "type": "array", "items": { "$ref": "#/components/schemas/PlanModuleRequest" } }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "daysOfWeek": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CreateReadingPlanRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "testament": { "enum": [ "Old", "New" ], "type": "string" }, "planName": { "type": "string" }, "readingPlanType": { "enum": [ "Verse", "Chapter" ], "type": "string" }, "startFromBookID": { "type": "integer", "format": "int64" }, "fromChapter": { "type": "integer", "format": "int32" }, "finishUpToBookID": { "type": "integer", "format": "int64" }, "toChapter": { "type": "integer", "format": "int32" }, "pace": { "type": "integer", "format": "int32" }, "days": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "EditLessonPlanRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "additionalProperties": false }, "EditPracticeGoalsPlanRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "additionalProperties": false }, "EditReadingPlanRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "planName": { "type": "string" } }, "additionalProperties": false }, "CreateQuestionRequest": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "questionType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "strongsNumber": { "type": "string" }, "orderingLocation": { "type": "string" }, "activityID": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AskQuestionRequest": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "activityID": { "type": "integer", "format": "int64" }, "learningMode": { "enum": [ "Lesson", "Deck" ], "type": "string" } }, "additionalProperties": false }, "PostAnswerRequest": { "type": "object", "properties": { "questionId": { "type": "integer", "format": "int64" }, "answer": { "type": "string" } }, "additionalProperties": false }, "EditAnswerRequest": { "type": "object", "properties": { "answerId": { "type": "integer", "format": "int64" }, "answer": { "type": "string" } }, "additionalProperties": false }, "GetReadComprehensionResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetReadComprehensionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetReadComprehensionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyReadComprehensionAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyReadComprehensionActivityRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyReadComprehensionAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyReadComprehensionAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyReadComprehensionAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyReadComprehensionActivityResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyReadComprehensionAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyReadComprehensionAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyReadComprehensionActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyReadComprehensionActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipReadComprehensionActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipReadComprehensionActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipReadComprehensionActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextReadComprehensionActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextReadComprehensionActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextReadComprehensionActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLessonReadingComprehensionDecksNameResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isArchived": { "type": "boolean" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" } }, "additionalProperties": false }, "GetLessonReadingComprehensionDecksResponse": { "type": "object", "properties": { "lessonNumber": { "type": "integer", "format": "int32" }, "decks": { "type": "array", "items": { "$ref": "#/components/schemas/GetLessonReadingComprehensionDecksNameResponse" } } }, "additionalProperties": false }, "GetLessonReadingComprehensionDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonReadingComprehensionDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBankReadingComprehensionDecksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "isArchived": { "type": "boolean" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetBankReadingComprehensionDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBankReadingComprehensionDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetOtherReadingComprehensionDecksResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "isArchived": { "type": "boolean" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "availablePoints": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } } }, "additionalProperties": false }, "GetOtherReadingComprehensionDecksResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetOtherReadingComprehensionDecksResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetReadingComprehensionDeckResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "GetReadingComprehensionDeckResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetReadingComprehensionDeckResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckActivityAudioAnswerRequest": { "type": "object", "properties": { "fileName": { "type": "string" }, "file": { "type": "string" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckActivityRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "answer": { "type": "string" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSuccess": { "type": "boolean" }, "audioFile": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityAudioAnswerRequest" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckAnswerSpellChekResultResponse": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "isSpellingMistake": { "type": "boolean" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckAnswerPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "pronunciation": { "type": "string" }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckActivityResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckAnswerSpellChekResultResponse" } }, "correctAnswers": { "type": "array", "items": { "type": "string" } }, "pronunciation": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckAnswerPronunciationResponse" } }, "additionalProperties": false }, "VerifyReadComprehensionDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/VerifyReadComprehensionDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SkipReadComprehensionDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "SkipReadComprehensionDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/SkipReadComprehensionDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "NextReadComprehensionDeckActivityResponse": { "type": "object", "properties": { "isCompleted": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "lessonId": { "type": "integer", "format": "int64" }, "nextLessonId": { "type": "integer", "format": "int64" }, "lessonStageId": { "type": "integer", "format": "int64" }, "lessonNumber": { "type": "integer", "format": "int32" }, "displayLessonNumber": { "type": "string" }, "name": { "type": "string" }, "phase": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "question": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int64" }, "activity": { "type": "object" }, "isBackEnabled": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "isBackToLearningEnabled": { "type": "boolean" }, "isTestPassed": { "type": "boolean" }, "correctAnswers": { "type": "integer", "format": "int32" }, "incorrectAnswers": { "type": "integer", "format": "int32" }, "percentageScored": { "type": "integer", "format": "int32" }, "nextLearnActivityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string", "nullable": true }, "nextLearnDeckId": { "type": "integer", "format": "int64", "nullable": true }, "lessonCompletedActivity": { "$ref": "#/components/schemas/CompletedActivitySvcModel" }, "pointsEarned": { "$ref": "#/components/schemas/ActivityPointsRewardSvcModel" } }, "additionalProperties": false }, "NextReadComprehensionDeckActivityResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/NextReadComprehensionDeckActivityResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSearchHistoryResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "language": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "searchedOn": { "type": "string", "format": "date-time" }, "searchParamType": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "searchTerm": { "type": "string" } }, "additionalProperties": false }, "GetSearchHistoryResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSearchHistoryResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSearchHistoriesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "language": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "searchedOn": { "type": "string", "format": "date-time" }, "searchParamType": { "$ref": "#/components/schemas/EnumResponseSvcModel" }, "searchTerm": { "type": "string" } }, "additionalProperties": false }, "GetSearchHistoriesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetSearchHistoriesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "LogSessionRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "sessionId": { "type": "string" }, "module": { "enum": [ "LanguageLearning", "FlashCard", "WTNP", "BibleReading", "FluencyDrills", "ReadingComprehension", "SessionEnd" ], "type": "string" } }, "additionalProperties": false }, "LogSessionResponse": { "type": "object", "properties": { "sessionId": { "type": "string" }, "startedOn": { "type": "string" } }, "additionalProperties": false }, "LogSessionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/LogSessionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "FurthestLessonModel": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "label": { "type": "string" } }, "additionalProperties": false }, "LearnerGlobalStatsModel": { "type": "object", "properties": { "furthestLesson": { "$ref": "#/components/schemas/FurthestLessonModel" }, "wordsLearned": { "type": "integer", "format": "int32", "nullable": true }, "wpm": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "LearnerWeeklyXpModel": { "type": "object", "properties": { "learn": { "type": "integer", "format": "int32" }, "retain": { "type": "integer", "format": "int32" }, "fluency": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LearnerWeeklyStatsModel": { "type": "object", "properties": { "xp": { "$ref": "#/components/schemas/LearnerWeeklyXpModel" }, "newWords": { "type": "integer", "format": "int32" }, "weekStart": { "type": "string" }, "weekEnd": { "type": "string" } }, "additionalProperties": false }, "GetLearnerDashboardResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "global": { "$ref": "#/components/schemas/LearnerGlobalStatsModel" }, "weekly": { "$ref": "#/components/schemas/LearnerWeeklyStatsModel" }, "streakDays": { "type": "integer", "format": "int32", "nullable": true }, "stats": { "$ref": "#/components/schemas/LearnerStatCardModel" } }, "additionalProperties": false }, "GetLearnerDashboardResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLearnerDashboardResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "WeeklyXpPointModel": { "type": "object", "properties": { "weekStart": { "type": "string", "format": "date-time" }, "total": { "type": "integer", "format": "int32" }, "learn": { "type": "integer", "format": "int32" }, "retain": { "type": "integer", "format": "int32" }, "fluency": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetWeeklyXpHistoryResponse": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "weeks": { "type": "array", "items": { "$ref": "#/components/schemas/WeeklyXpPointModel" } } }, "additionalProperties": false }, "GetWeeklyXpHistoryResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetWeeklyXpHistoryResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLearningReasonResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reason": { "type": "string" } }, "additionalProperties": false }, "GetLatinPronunciationResponse": { "type": "object", "properties": { "pronunciation": { "enum": [ "Classical", "Ecclesiastical" ], "type": "string", "nullable": true }, "description": { "type": "string" } }, "additionalProperties": false }, "GetAramaicPronunciationResponse": { "type": "object", "properties": { "pronunciation": { "enum": [ "Ancient" ], "type": "string", "nullable": true }, "description": { "type": "string" } }, "additionalProperties": false }, "GetEnglishPronunciationResponse": { "type": "object", "properties": { "pronunciation": { "enum": [ "Modern" ], "type": "string", "nullable": true }, "description": { "type": "string" } }, "additionalProperties": false }, "GetStudentLanguageResponse": { "type": "object", "properties": { "language": { "$ref": "#/components/schemas/GetLanguageENUMResponse" }, "hebrewPronunciation": { "$ref": "#/components/schemas/GetHebrewPronunciationResponse" }, "greekPronunciation": { "$ref": "#/components/schemas/GetGreekPronunciationResponse" }, "latinPronunciation": { "$ref": "#/components/schemas/GetLatinPronunciationResponse" }, "aramaicPronunciation": { "$ref": "#/components/schemas/GetAramaicPronunciationResponse" }, "englishPronunciation": { "$ref": "#/components/schemas/GetEnglishPronunciationResponse" }, "experienceInSpeaking": { "type": "string" }, "avatar": { "$ref": "#/components/schemas/GetAvatarResponse" } }, "additionalProperties": false }, "SubscriptionDetailsResponse": { "type": "object", "properties": { "subscriptionPlan": { "type": "string" }, "languageSubscribed": { "type": "string" }, "trialStatus": { "type": "boolean", "nullable": true }, "subscriptionType": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetStudentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "country": { "$ref": "#/components/schemas/GetCountryResponse" }, "learningReason": { "$ref": "#/components/schemas/GetLearningReasonResponse" }, "previousStudyOrSearch": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "isActive": { "type": "boolean" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/GetStudentLanguageResponse" } }, "classRoomCodes": { "type": "string" }, "isSubscriptionValid": { "type": "boolean" }, "subscriptionDetails": { "$ref": "#/components/schemas/SubscriptionDetailsResponse" } }, "additionalProperties": false }, "GetStudentResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetStudentResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateStudentLanguageRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciationType": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "englishPronunciationType": { "enum": [ "Modern" ], "type": "string", "nullable": true }, "latinPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "aramaicPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "experienceInSpeaking": { "type": "string" }, "avatarID": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CreateStudentRequest": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "resetPasswordLinkURL": { "type": "string" }, "learningReasonID": { "type": "integer", "format": "int64", "nullable": true }, "previousStudyOrSearch": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/CreateStudentLanguageRequest" } } }, "additionalProperties": false }, "TriggerEmailRequest": { "type": "object", "properties": { "resetPasswordLinkURL": { "type": "string" } }, "additionalProperties": false }, "EditStudentLanguageRequest": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciationType": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "englishPronunciationType": { "enum": [ "Modern" ], "type": "string", "nullable": true }, "latinPronunciationType": { "enum": [ "Classical", "Ecclesiastical" ], "type": "string", "nullable": true }, "aramaicPronunciationType": { "enum": [ "Ancient" ], "type": "string", "nullable": true }, "experienceInSpeaking": { "type": "string" }, "avatarID": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "EditStudentRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "learningReasonID": { "type": "integer", "format": "int64", "nullable": true }, "previousStudyOrSearch": { "type": "string" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/EditStudentLanguageRequest" } } }, "additionalProperties": false }, "UpdatePreferenceRequest": { "type": "object", "properties": { "learningReasonID": { "type": "integer", "format": "int64", "nullable": true }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "experienceInGreek": { "type": "string" }, "experienceInHebrew": { "type": "string" }, "experienceInEnglish": { "type": "string" }, "experienceInLatin": { "type": "string" }, "experienceInAramaic": { "type": "string" }, "hebrewPronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "englishPronunciation": { "enum": [ "Modern" ], "type": "string", "nullable": true }, "latinPronunciation": { "enum": [ "Classical", "Ecclesiastical" ], "type": "string", "nullable": true }, "aramaicPronunciation": { "enum": [ "Ancient" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "DisableSpeakingRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "isRecordingAllowed": { "type": "boolean" } }, "additionalProperties": false }, "TodoItemSvcModel": { "type": "object", "properties": { "todoType": { "enum": [ "Alphabet", "Lesson", "VocabPractice" ], "type": "string" }, "labelContent": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "activityType": { "enum": [ "Deck", "Lesson", "FluencyDrill", "ReadingComprehension" ], "type": "string" } }, "additionalProperties": false }, "GetTodoResponse": { "type": "object", "properties": { "todoItemSvcModels": { "type": "array", "items": { "$ref": "#/components/schemas/TodoItemSvcModel" } } }, "additionalProperties": false }, "GetTodoResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetTodoResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetStreakResponse": { "type": "object", "properties": { "currentStreakInDays": { "type": "integer", "format": "int32" }, "currentStreakPercentage": { "type": "integer", "format": "int32" }, "isCurrentPercentageIncrease": { "type": "boolean" }, "longestStreakInDays": { "type": "integer", "format": "int32" }, "longestStreakPercentage": { "type": "integer", "format": "int32" }, "isLongestPercentageIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetStreakResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetStreakResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetPlanDetails": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "planType": { "enum": [ "LessonGoals", "ReadingGoals", "PracticeGoals" ], "type": "string" }, "task": { "type": "string" } }, "additionalProperties": false }, "GetPlannerResponse": { "type": "object", "properties": { "numberOfTasks": { "type": "integer", "format": "int32" }, "percentageOfLearning": { "type": "integer", "format": "int32" }, "planDetails": { "type": "array", "items": { "$ref": "#/components/schemas/GetPlanDetails" } } }, "additionalProperties": false }, "GetPlannerResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPlannerResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetRecordingsResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "word": { "type": "string" }, "strongsNumber": { "type": "string" }, "isCorrect": { "type": "boolean" }, "fileName": { "type": "string" }, "filePath": { "type": "string" }, "originalFilePath": { "type": "string" }, "originalFileName": { "type": "string" }, "attemptedOn": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetRecordingsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetRecordingsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetHomeResponse": { "type": "object", "properties": { "wordsLearned": { "type": "integer", "format": "int32" }, "wordsLearnedPercentage": { "type": "integer", "format": "int32" }, "lessonsLearned": { "type": "integer", "format": "int32" }, "lessonsLearnedPercentage": { "type": "integer", "format": "int32" }, "totalLessons": { "type": "integer", "format": "int32" }, "achievementBadges": { "type": "array", "items": { "$ref": "#/components/schemas/AchievementBadgeFamilySvcModel" } } }, "additionalProperties": false }, "GetHomeResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetHomeResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDashboardResponse": { "type": "object", "properties": { "streak": { "type": "integer", "format": "int32" }, "wordsPerMinute": { "type": "integer", "format": "int32" }, "pointsPerCategoryGoal": { "type": "integer", "format": "int32" }, "learnGoalPercentEarned": { "type": "number", "format": "double" }, "retainGoalPercentEarned": { "type": "number", "format": "double" }, "fluencyGoalPercentEarned": { "type": "number", "format": "double" }, "timeSpent": { "type": "string" }, "newWords": { "type": "integer", "format": "int32" }, "pointsEarned": { "type": "integer", "format": "int32" }, "previousWeekTimeSpent": { "type": "string" }, "previousWeekNewWords": { "type": "integer", "format": "int32" }, "previousWeekPointsEarned": { "type": "integer", "format": "int32" }, "totalWordsLearned": { "type": "integer", "format": "int32" }, "percentOfBibleWordsLearned": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetDashboardResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDashboardResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "TotalTimeTakenFormats": { "type": "object", "properties": { "seconds": { "type": "integer", "format": "int32" }, "minutes": { "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32" }, "totalSeconds": { "type": "number", "format": "double" }, "totalMinutes": { "type": "number", "format": "double" }, "totalHours": { "type": "number", "format": "double" }, "totalDays": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetTimeSpentOverviewResponse": { "type": "object", "properties": { "totalTimeTakenInMs": { "type": "number", "format": "double" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" }, "totalTimeTaken": { "$ref": "#/components/schemas/TotalTimeTakenFormats" } }, "additionalProperties": false }, "GetTimeSpentOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetTimeSpentOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDaysActivityOverviewResponse": { "type": "object", "properties": { "numberOfDaysSpent": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetDaysActivityOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDaysActivityOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSessionActivityOverviewResponse": { "type": "object", "properties": { "numberOfSessions": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetSessionActivityOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSessionActivityOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetPointActivityOverviewResponse": { "type": "object", "properties": { "pointsAccumulated": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetPointActivityOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPointActivityOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetDaysSpentLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetDaysSpentLearningResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetDaysSpentLearningResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetPointsAccumulatedResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetPointsAccumulatedResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetPointsAccumulatedResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetNumberOfSessionsResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetNumberOfSessionsResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetNumberOfSessionsResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetTimeSpentLearningResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetTimeSpentLearningResponseListBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetTimeSpentLearningResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetNumberOfWordsLearnedVocabularyOverviewResponse": { "type": "object", "properties": { "numberOfWordsLearned": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetNumberOfWordsLearnedVocabularyOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedVocabularyOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetVocabularyProficiencyOverviewResponse": { "type": "object", "properties": { "proficiencyPercentage": { "type": "integer", "format": "int32" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetVocabularyProficiencyOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetVocabularyProficiencyOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetNumberOfWordsLearnedResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetNumberOfWordsLearnedResponseListBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetNumberOfWordsLearnedResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetVocabularyProficiencyResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetVocabularyProficiencyResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetVocabularyProficiencyResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetWordsInEachLearningStageResponse": { "type": "object", "properties": { "singleSenseLearnedWords": { "type": "integer", "format": "int32" }, "multipleSensesLearnedWords": { "type": "integer", "format": "int32" }, "allSenseLearnedWords": { "type": "integer", "format": "int32" }, "wordsWithAllSensesArchived": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetWordsInEachLearningStageResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetWordsInEachLearningStageResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "TimesIncorrectResponse": { "type": "object", "properties": { "incorrectAttempts": { "type": "integer", "format": "int32" }, "correctPercentage": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StageResponse": { "type": "object", "properties": { "currentStage": { "type": "integer", "format": "int32" }, "totalStages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetWordsLearnedResponse": { "type": "object", "properties": { "wordLearned": { "type": "string" }, "gloss": { "type": "string" }, "timesIncorrect": { "$ref": "#/components/schemas/TimesIncorrectResponse" }, "stage": { "$ref": "#/components/schemas/StageResponse" } }, "additionalProperties": false }, "GetWordsLearnedResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetWordsLearnedResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetTopicGrammarOverviewResponse": { "type": "object", "properties": { "numberOfTopicsLearned": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetTopicGrammarOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetTopicGrammarOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSentenceGrammarOverviewResponse": { "type": "object", "properties": { "numberOfSentencesPracticed": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetSentenceGrammarOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSentenceGrammarOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetTopicGrammarChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetTopicGrammarChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetTopicGrammarChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetSentenceGrammarChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetSentenceGrammarChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetSentenceGrammarChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetProficiencyGrammarChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetProficiencyGrammarChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetProficiencyGrammarChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "FluencyDrillStageResponse": { "type": "object", "properties": { "currentStage": { "type": "integer", "format": "int32" }, "totalStages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetFluencyDrillReportResponse": { "type": "object", "properties": { "paradigm": { "type": "string" }, "timesIncorrect": { "type": "integer", "format": "int32" }, "stage": { "$ref": "#/components/schemas/FluencyDrillStageResponse" }, "firstEncounter": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetFluencyDrillReportResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetFluencyDrillReportResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetGrammarTopicLearnedResponse": { "type": "object", "properties": { "topic": { "type": "string" }, "inCorrectFrequency": { "type": "string" }, "subLesson": { "type": "string" }, "firstEncounter": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetGrammarTopicLearnedResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetGrammarTopicLearnedResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChaptersReadingOverviewResponse": { "type": "object", "properties": { "numberOfChaptersCompleted": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetChaptersReadingOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChaptersReadingOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBooksReadingOverviewResponse": { "type": "object", "properties": { "numberOfBooksCompleted": { "type": "integer", "format": "int64" }, "percentageChange": { "type": "integer", "format": "int32" }, "isIncrease": { "type": "boolean" } }, "additionalProperties": false }, "GetBooksReadingOverviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBooksReadingOverviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChaptersCompletedReadingLineChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetChaptersCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetChaptersCompletedReadingLineChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBooksCompletedReadingLineChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "GetBooksCompletedReadingLineChartResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetBooksCompletedReadingLineChartResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetWordsLearnedReadingRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetWordsLearnedReadingRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetWordsLearnedReadingRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChaptersCompletedReadingRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetChaptersCompletedReadingRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChaptersCompletedReadingRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetBooksCompletedReadingRoundChartResponse": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetBooksCompletedReadingRoundChartResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBooksCompletedReadingRoundChartResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChaptersCompletedResponse": { "type": "object", "properties": { "chapter": { "type": "string" }, "percentage": { "type": "integer", "format": "int32" }, "dateCompleted": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetChaptersCompletedResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChaptersCompletedResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetReadingComprehensionReportResponse": { "type": "object", "properties": { "question": { "type": "string" }, "inCorrectFrequency": { "type": "integer", "format": "int32" }, "dateCompleted": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetReadingComprehensionReportResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetReadingComprehensionReportResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SubscriptionEntitlementDto": { "type": "object", "properties": { "type": { "enum": [ "Learn", "BibleRead", "Community", "Flashcards" ], "type": "string" }, "scope": { "enum": [ "PerLanguage", "AccountLevel" ], "type": "string" }, "languageId": { "type": "integer", "format": "int32", "nullable": true }, "endsAtTermEnd": { "type": "boolean" } }, "additionalProperties": false }, "SubscriptionSeatDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "email": { "type": "string" }, "isLoggedInUser": { "type": "boolean" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string", "nullable": true }, "pricePerPeriodCents": { "type": "integer", "format": "int64", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true }, "status": { "enum": [ "Active", "CancellationPending", "Cancelled", "Suspended" ], "type": "string", "nullable": true }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionEntitlementDto" } }, "includesAllFutureLanguages": { "type": "boolean", "nullable": true }, "pendingChangeEffectiveOn": { "type": "string", "format": "date-time", "nullable": true }, "isAdultConfirmed": { "type": "boolean", "nullable": true }, "legacyPlan": { "enum": [ "Basic", "StandardOne", "StandardTwo", "Premium", "Free" ], "type": "string", "nullable": true }, "isTrial": { "type": "boolean" } }, "additionalProperties": false }, "GetSubscriptionResponse": { "type": "object", "properties": { "isLegacy": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "owner": { "$ref": "#/components/schemas/SubscriptionSeatDto" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionSeatDto" } }, "maxFamilySeats": { "type": "integer", "format": "int32" }, "renewalPaymentFailed": { "type": "boolean" }, "renewalGraceEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "billingCurrency": { "type": "string" }, "currencyLocked": { "type": "boolean" } }, "additionalProperties": false }, "GetSubscriptionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSubscriptionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SetMemberSocialAccessRequest": { "type": "object", "properties": { "memberUserId": { "type": "integer", "format": "int64" }, "allowed": { "type": "boolean" } }, "additionalProperties": false }, "ValidateCouponRequest": { "type": "object", "properties": { "code": { "type": "string" } }, "additionalProperties": false }, "ValidateCouponResponse": { "type": "object", "properties": { "valid": { "type": "boolean" }, "reason": { "type": "string" }, "code": { "type": "string" }, "kind": { "type": "string" }, "isPercentage": { "type": "boolean" }, "discountPercentage": { "type": "number", "format": "double" }, "discountAmountCents": { "type": "integer", "format": "int64" }, "durationType": { "type": "string" }, "durationMonths": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ValidateCouponResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/ValidateCouponResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "InvoiceDto": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time", "nullable": true }, "total": { "type": "integer", "format": "int64" }, "currencyCode": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": false }, "GetBillingHistoryResponse": { "type": "object", "properties": { "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDto" } }, "nextOffset": { "type": "string" } }, "additionalProperties": false }, "GetBillingHistoryResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetBillingHistoryResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetInvoicePdfResponse": { "type": "object", "properties": { "url": { "type": "string" }, "validTill": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "GetInvoicePdfResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetInvoicePdfResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetChargebeeConfigResponse": { "type": "object", "properties": { "site": { "type": "string" }, "publishableKey": { "type": "string" } }, "additionalProperties": false }, "GetChargebeeConfigResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetChargebeeConfigResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SavePaymentMethodRequest": { "type": "object", "properties": { "token": { "type": "string" }, "gatewayAccountId": { "type": "string" }, "currency": { "type": "string" } }, "additionalProperties": false }, "PaymentMethodDto": { "type": "object", "properties": { "id": { "type": "string" }, "cardBrand": { "type": "string" }, "lastFour": { "type": "string" }, "expiryMonth": { "type": "integer", "format": "int32" }, "expiryYear": { "type": "integer", "format": "int32" }, "isPrimary": { "type": "boolean" }, "cardholderName": { "type": "string" } }, "additionalProperties": false }, "PaymentMethodDtoBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/PaymentMethodDto" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetPaymentMethodResponse": { "type": "object", "properties": { "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } } }, "additionalProperties": false }, "GetPaymentMethodResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPaymentMethodResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UpdatePaymentMethodRequest": { "type": "object", "properties": { "paymentSourceId": { "type": "string" }, "expiryMonth": { "type": "integer", "format": "int32" }, "expiryYear": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ProposedEntitlementDto": { "type": "object", "properties": { "type": { "enum": [ "Learn", "BibleRead", "Community", "Flashcards" ], "type": "string" }, "languageId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ProposedMemberDto": { "type": "object", "properties": { "reference": { "type": "string" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "includesAllFutureLanguages": { "type": "boolean" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedEntitlementDto" } }, "isFlashcardsPlan": { "type": "boolean" } }, "additionalProperties": false }, "PlanChangeDto": { "type": "object", "properties": { "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "includesAllFutureLanguages": { "type": "boolean" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedEntitlementDto" } }, "isFlashcardsPlan": { "type": "boolean" } }, "additionalProperties": false }, "MemberPlanChangeDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "cancel": { "type": "boolean" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "includesAllFutureLanguages": { "type": "boolean" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedEntitlementDto" } }, "isFlashcardsPlan": { "type": "boolean" }, "isAdultConfirmed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "GetPricingPreviewRequest": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedMemberDto" } }, "currency": { "type": "string" }, "ownerPlanChange": { "$ref": "#/components/schemas/PlanChangeDto" }, "memberPlanChanges": { "type": "array", "items": { "$ref": "#/components/schemas/MemberPlanChangeDto" } }, "couponCodes": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PreviewSeatDto": { "type": "object", "properties": { "reference": { "type": "string" }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "basePricePerPeriod": { "type": "number", "format": "double" }, "volumeDiscountPercent": { "type": "number", "format": "double" }, "pricePerPeriod": { "type": "number", "format": "double" }, "previousPricePerPeriod": { "type": "number", "format": "double", "nullable": true }, "nextBillDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CancelledSeatDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RenewalImpactDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "fromPricePerPeriod": { "type": "number", "format": "double" }, "toPricePerPeriod": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AppliedCouponDto": { "type": "object", "properties": { "code": { "type": "string" }, "kind": { "type": "string" }, "isPercentage": { "type": "boolean" }, "discountPercentage": { "type": "number", "format": "double" }, "discountAmountCents": { "type": "integer", "format": "int64" }, "durationType": { "type": "string" }, "durationMonths": { "type": "integer", "format": "int32", "nullable": true }, "discountAppliedToday": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetPricingPreviewResponse": { "type": "object", "properties": { "currency": { "type": "string" }, "currencyLocked": { "type": "boolean" }, "newMembers": { "type": "array", "items": { "$ref": "#/components/schemas/PreviewSeatDto" } }, "existingMembers": { "type": "array", "items": { "$ref": "#/components/schemas/PreviewSeatDto" } }, "changedMembers": { "type": "array", "items": { "$ref": "#/components/schemas/PreviewSeatDto" } }, "cancelledMembers": { "type": "array", "items": { "$ref": "#/components/schemas/CancelledSeatDto" } }, "renewalIncreases": { "type": "array", "items": { "$ref": "#/components/schemas/RenewalImpactDto" } }, "newSubscriptionsDueToday": { "type": "number", "format": "double" }, "totalDueToday": { "type": "number", "format": "double" }, "ownerPlanChange": { "$ref": "#/components/schemas/PreviewSeatDto" }, "estimatedCredit": { "type": "number", "format": "double" }, "estimatedConversionCredit": { "type": "number", "format": "double" }, "estimatedUpgradeCredit": { "type": "number", "format": "double" }, "estimatedRetroDiscountCredit": { "type": "number", "format": "double" }, "appliedCoupons": { "type": "array", "items": { "$ref": "#/components/schemas/AppliedCouponDto" } }, "couponDiscountApplied": { "type": "number", "format": "double" }, "creditApplied": { "type": "number", "format": "double" }, "netDueToday": { "type": "number", "format": "double" }, "remainingCredit": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetPricingPreviewResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetPricingPreviewResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CheckoutMemberDto": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "billingFrequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "includesAllFutureLanguages": { "type": "boolean" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/ProposedEntitlementDto" } }, "isFlashcardsPlan": { "type": "boolean" }, "isAdultConfirmed": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CheckoutRequest": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/CheckoutMemberDto" } }, "currency": { "type": "string" }, "ownerPlanChange": { "$ref": "#/components/schemas/PlanChangeDto" }, "memberPlanChanges": { "type": "array", "items": { "$ref": "#/components/schemas/MemberPlanChangeDto" } }, "couponCodes": { "type": "array", "items": { "type": "string" } }, "cancelWholePlan": { "type": "boolean" }, "paymentToken": { "type": "string" }, "gatewayAccountId": { "type": "string" }, "paymentSourceId": { "type": "string" }, "idempotencyKey": { "type": "string" }, "saveCard": { "type": "boolean" } }, "additionalProperties": false }, "CheckoutSeatDto": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "CheckoutResponse": { "type": "object", "properties": { "chargebeeInvoiceId": { "type": "string" }, "grossChargedCents": { "type": "integer", "format": "int64" }, "creditAppliedCents": { "type": "integer", "format": "int64" }, "netChargedCents": { "type": "integer", "format": "int64" }, "seats": { "type": "array", "items": { "$ref": "#/components/schemas/CheckoutSeatDto" } } }, "additionalProperties": false }, "CheckoutResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/CheckoutResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CurrencyPriceDto": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "EntitlementOptionDto": { "type": "object", "properties": { "type": { "enum": [ "Learn", "BibleRead", "Community", "Flashcards" ], "type": "string" }, "scope": { "enum": [ "PerLanguage", "AccountLevel" ], "type": "string" }, "monthlyBasePrice": { "type": "number", "format": "double" }, "isEnabled": { "type": "boolean" }, "currencyPrices": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyPriceDto" } } }, "additionalProperties": false }, "FrequencyOptionDto": { "type": "object", "properties": { "frequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "billingMonths": { "type": "integer", "format": "int32", "nullable": true }, "discountPercent": { "type": "number", "format": "double" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "LifetimePricingTierDto": { "type": "object", "properties": { "maxLanguages": { "type": "integer", "format": "int32", "nullable": true }, "oneTimePrice": { "type": "number", "format": "double" }, "currencyPrices": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyPriceDto" } } }, "additionalProperties": false }, "VolumeDiscountDto": { "type": "object", "properties": { "minSeats": { "type": "integer", "format": "int32" }, "maxSeats": { "type": "integer", "format": "int32", "nullable": true }, "discountPercent": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AvailableLanguageDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "localizationKey": { "type": "string" } }, "additionalProperties": false }, "GetSubscriptionConfigurationResponse": { "type": "object", "properties": { "effectiveFrom": { "type": "string", "format": "date-time", "nullable": true }, "maxFamilySeats": { "type": "integer", "format": "int32" }, "allAccessMonthlyPrice": { "type": "number", "format": "double" }, "newModelSignupEnabled": { "type": "boolean" }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOptionDto" } }, "frequencyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyOptionDto" } }, "lifetimePricingTiers": { "type": "array", "items": { "$ref": "#/components/schemas/LifetimePricingTierDto" } }, "volumeDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeDiscountDto" } }, "availableLanguages": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableLanguageDto" } }, "pendingConfiguration": { "$ref": "#/components/schemas/GetSubscriptionConfigurationResponse" } }, "additionalProperties": false }, "GetSubscriptionConfigurationResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetSubscriptionConfigurationResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CurrencyPriceInput": { "type": "object", "properties": { "currencyCode": { "type": "string" }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "EntitlementOptionInput": { "type": "object", "properties": { "type": { "enum": [ "Learn", "BibleRead", "Community", "Flashcards" ], "type": "string" }, "scope": { "enum": [ "PerLanguage", "AccountLevel" ], "type": "string" }, "monthlyBasePrice": { "type": "number", "format": "double" }, "isEnabled": { "type": "boolean" }, "currencyPrices": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyPriceInput" } } }, "additionalProperties": false }, "FrequencyOptionInput": { "type": "object", "properties": { "frequency": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string" }, "billingMonths": { "type": "integer", "format": "int32", "nullable": true }, "discountPercent": { "type": "number", "format": "double" }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "LifetimePricingTierInput": { "type": "object", "properties": { "maxLanguages": { "type": "integer", "format": "int32", "nullable": true }, "oneTimePrice": { "type": "number", "format": "double" }, "currencyPrices": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyPriceInput" } } }, "additionalProperties": false }, "VolumeDiscountInput": { "type": "object", "properties": { "minSeats": { "type": "integer", "format": "int32" }, "maxSeats": { "type": "integer", "format": "int32", "nullable": true }, "discountPercent": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UpdateSubscriptionConfigurationRequest": { "type": "object", "properties": { "effectiveFrom": { "type": "string", "format": "date-time", "nullable": true }, "maxFamilySeats": { "type": "integer", "format": "int32", "nullable": true }, "allAccessMonthlyPrice": { "type": "number", "format": "double", "nullable": true }, "newModelSignupEnabled": { "type": "boolean", "nullable": true }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/EntitlementOptionInput" } }, "frequencyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyOptionInput" } }, "lifetimePricingTiers": { "type": "array", "items": { "$ref": "#/components/schemas/LifetimePricingTierInput" } }, "volumeDiscounts": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeDiscountInput" } } }, "additionalProperties": false }, "PlanDTO": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "integer", "format": "int64", "nullable": true }, "currencyCode": { "type": "string" }, "periodUnit": { "enum": [ "UnKnown", "Day", "Week", "Month", "Year" ], "type": "string" }, "period": { "type": "integer", "format": "int32" }, "monthlyPrice": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ListPlansResponse": { "type": "object", "properties": { "monthlyPlans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDTO" } }, "halfyearlyPlans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDTO" } }, "annualPlans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDTO" } }, "lifetimePlans": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDTO" } } }, "additionalProperties": false }, "ListPlansResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/ListPlansResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreateSubscriptionRequest": { "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "planId": { "type": "string" }, "trialEnd": { "type": "integer", "format": "int64" }, "coupon": { "type": "string" }, "affiliateToken": { "type": "string" }, "tid": { "type": "string" } }, "additionalProperties": false }, "Int32BiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "integer", "format": "int32" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "CreatePortalSessionRequest": { "type": "object", "properties": { "email": { "type": "string" }, "customerId": { "type": "string" } }, "additionalProperties": false }, "CreatePortalSessionResponse": { "type": "object", "properties": { "accessUrl": { "type": "string" } }, "additionalProperties": false }, "CreatePortalSessionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/CreatePortalSessionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UserRetrialRequest": { "type": "object", "properties": { "email": { "type": "string" }, "trialDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AvatarLevelResponse": { "type": "object", "properties": { "rowId": { "type": "string", "format": "uuid" }, "level": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "GetLatestAvatarsResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "description": { "type": "string" }, "filePath": { "type": "string" }, "rowId": { "type": "string", "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "avatarLevels": { "type": "array", "items": { "$ref": "#/components/schemas/AvatarLevelResponse" } } }, "additionalProperties": false }, "GetLatestAvatarsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestAvatarsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestLearningReasonsResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "rowId": { "type": "string", "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "GetLatestLearningReasonsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestLearningReasonsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestCoursesResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "courseID": { "type": "string" }, "origin": { "enum": [ "CampusEdu", "Fuller" ], "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fromLessonNumber": { "type": "integer", "format": "int32" }, "toLessonNumber": { "type": "integer", "format": "int32" }, "isBibleReading": { "type": "boolean" }, "isFlashCardDeck": { "type": "boolean" }, "isLanguageLearning": { "type": "boolean" }, "isAlphabetDeckLearning": { "type": "boolean" }, "isVideoTutorials": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GetLatestCoursesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestCoursesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestInfoXMLFileResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "latestVersion": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLatestInfoResponse": { "type": "object", "properties": { "latestXMLs": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestInfoXMLFileResponse" } } }, "additionalProperties": false }, "GetLatestInfoResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestInfoResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestFluencyDrillSettingsResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "numberOfQuestions": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetLatestLearningSettingsResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "isPracticePopupEnabled": { "type": "boolean" } }, "additionalProperties": false }, "GetLatestFlashCardDeckSettingsResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "defaultDisplayField": { "enum": [ "Gloss", "Definition" ], "type": "string" }, "wordsPerDeck": { "type": "integer", "format": "int32" }, "initialStageOfReview": { "enum": [ "Association", "PassiveEasy", "PassiveHard", "Active" ], "type": "string" }, "displayArchivedWords": { "type": "boolean" } }, "additionalProperties": false }, "GetLatestUserLanguageInfoResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "description": { "type": "string" }, "experienceInSpeaking": { "type": "string" }, "experienceInWriting": { "type": "string" }, "experienceInTeaching": { "type": "string" }, "greekPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "hebrewPronunciationType": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "badge": { "type": "string" }, "points": { "type": "number", "format": "double", "nullable": true }, "avatarID": { "type": "string", "format": "uuid", "nullable": true }, "subscriptionType": { "enum": [ "Monthly", "HalfYearly", "Annually", "Free", "Lifetime" ], "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "expiry": { "type": "string", "format": "date-time", "nullable": true }, "isTrial": { "type": "boolean" }, "isRecordingAllowed": { "type": "boolean" } }, "additionalProperties": false }, "GetLatestUserInfoResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "rowId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" }, "passwordHash": { "type": "string", "format": "byte" }, "passwordSalt": { "type": "string", "format": "byte" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "countryCode": { "type": "string" }, "isActive": { "type": "boolean" }, "universityOrOrganization": { "type": "string" }, "nativeLanguage": { "type": "string" }, "otherLanguages": { "type": "string" }, "learningReasonID": { "type": "string", "format": "uuid", "nullable": true }, "previousStudies": { "type": "string" }, "isSubscriptionValid": { "type": "boolean" }, "subscriptionPlan": { "enum": [ "Basic", "StandardOne", "StandardTwo", "Premium", "Free" ], "type": "string" }, "role": { "enum": [ "Admin", "InternalTeacher", "ExternalTeacher", "Student", "Thirdparty" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "fluencyDrillSettings": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestFluencyDrillSettingsResponse" } }, "learningSettings": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestLearningSettingsResponse" } }, "flashCardDeckSettings": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestFlashCardDeckSettingsResponse" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestUserLanguageInfoResponse" } } }, "additionalProperties": false }, "GetLatestUserInfoResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestUserInfoResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "LatestTeacherLanguageResponse": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "description": { "type": "string" }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "LatestClassroomTeacherResponse": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/LatestTeacherLanguageResponse" } } }, "additionalProperties": false }, "GetLatestClassroomsResponse": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "teacherID": { "type": "integer", "format": "int64" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "teacher": { "$ref": "#/components/schemas/LatestClassroomTeacherResponse" } }, "additionalProperties": false }, "GetLatestClassroomsResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestClassroomsResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestLessonGuidesResponse": { "type": "object", "properties": { "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "GetLatestLessonGuidesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestLessonGuidesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestVocabularyExampleResponse": { "type": "object", "properties": { "verse": { "type": "string" }, "reference": { "type": "string" } }, "additionalProperties": false }, "GetLatestVocabularyIllustrationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "fileType": { "type": "string" }, "caption": { "type": "string" } }, "additionalProperties": false }, "GetLatestVocabularyPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "pronunciationFiletype": { "enum": [ "Learning", "Reading" ], "type": "string" }, "senseNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetLatestVocabularySenseResponse": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32" }, "senseID": { "type": "string" }, "isPrimary": { "type": "boolean" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "gloss": { "type": "string" }, "glossl10n": { "type": "string" }, "senseFormLesson": { "type": "string" }, "senseFormDictionary": { "type": "string" }, "deckName": { "type": "string" }, "deckOrder": { "type": "integer", "format": "int32", "nullable": true }, "deckWordOrder": { "type": "integer", "format": "int32", "nullable": true }, "deckGroup": { "type": "string" }, "languageLearningDefinition": { "type": "string" }, "definition": { "type": "string" }, "semanticDomain": { "type": "string" }, "gender": { "type": "string" }, "argumentAlternations": { "type": "string" }, "argumentRealizations": { "type": "string" }, "binyan": { "type": "string" }, "yiqtol": { "type": "string" }, "qatal": { "type": "string" }, "wayyiqtol": { "type": "string" }, "weqatal": { "type": "string" }, "participle": { "type": "string" }, "passiveParticiple": { "type": "string" }, "imperative": { "type": "string" }, "jussive": { "type": "string" }, "cohortative": { "type": "string" }, "infinitiveConstruct": { "type": "string" }, "infinitiveAbsolute": { "type": "string" }, "grammaticalInfo": { "type": "string" }, "encyclopediaInfo": { "type": "string" }, "reversals": { "type": "string" }, "reversalsl10n": { "type": "string" }, "wordBank": { "type": "string" }, "picSource": { "type": "string" }, "isHideFromSearch": { "type": "boolean" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularyExampleResponse" } }, "illustrations": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularyIllustrationResponse" } }, "pronunciations": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularyPronunciationResponse" } } }, "additionalProperties": false }, "GetLatestVocabularyComponentResponse": { "type": "object", "properties": { "entryId": { "type": "string" }, "entryRefId": { "type": "string" }, "text": { "type": "string" }, "strongsNumber": { "type": "string" }, "actualStrongsNumber": { "type": "string" }, "complexFormType": { "enum": [ "Idiom", "Compound" ], "type": "string" } }, "additionalProperties": false }, "GetLatestVocabularyEntryResponse": { "type": "object", "properties": { "entryId": { "type": "string" }, "entryRefId": { "type": "string" }, "text": { "type": "string" }, "senseFormLesson": { "type": "string" }, "senseFormDictionary": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32", "nullable": true }, "strongsNumber": { "type": "string" }, "strongsNumber2": { "type": "string" }, "actualStrongsNumber": { "type": "string" }, "actualStrongsNumber2": { "type": "string" }, "morphType": { "type": "string" }, "morphologyTag": { "type": "string" }, "frequency": { "type": "string" }, "genN": { "type": "string" }, "plural": { "type": "string" }, "pluralConstruct": { "type": "string" }, "dual": { "type": "string" }, "hebrewRoot": { "type": "string" }, "greekRoot": { "type": "string" }, "dualConstruct": { "type": "string" }, "construct": { "type": "string" }, "adjForms": { "type": "string" }, "perfMid": { "type": "string" }, "perfect": { "type": "string" }, "future": { "type": "string" }, "futureMid": { "type": "string" }, "futurePasv": { "type": "string" }, "aorMid": { "type": "string" }, "aorPasv": { "type": "string" }, "aorist": { "type": "string" }, "imperfect": { "type": "string" }, "presMP": { "type": "string" }, "imperfectMP": { "type": "string" }, "nomFNAdj": { "type": "string" }, "components": { "type": "string" }, "complexFormType": { "type": "string" }, "senses": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularySenseResponse" } }, "vocabularyComponents": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularyComponentResponse" } } }, "additionalProperties": false }, "GetVocabularyLatestVersionResponse": { "type": "object", "properties": { "fileType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "version": { "type": "integer", "format": "int32" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestVocabularyEntryResponse" } } }, "additionalProperties": false }, "GetVocabularyLatestVersionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetVocabularyLatestVersionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestQuestionPromptResponse": { "type": "object", "properties": { "text": { "type": "string" }, "fileName": { "type": "string" }, "promptAudioPath": { "type": "string" }, "greekPronunciationType": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "hebrewPronunciationType": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "GetLatestGrammarPronunciationResponse": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "label": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "hebrewPronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "senseNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GetLatestGrammarSymbolResponse": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "filePath": { "type": "string" }, "fileName": { "type": "string" }, "symbolType": { "enum": [ "Verbs", "Picture2Verbs", "Nouns", "Picture2Nouns", "PP3", "Picture2PP3" ], "type": "string" } }, "additionalProperties": false }, "GetLatestGrammarCorrectAnswerResponse": { "type": "object", "properties": { "answer": { "type": "string" } }, "additionalProperties": false }, "GetLatestGrammarIncorrectAnswerResponse": { "type": "object", "properties": { "answer": { "type": "string" } }, "additionalProperties": false }, "GetLatestGrammarEntryResponse": { "type": "object", "properties": { "entryId": { "type": "string" }, "entryRefId": { "type": "string" }, "text": { "type": "string" }, "grammarVocab": { "type": "string" }, "lexemeForm": { "type": "string" }, "strongsNumber": { "type": "string" }, "orderLocation": { "type": "string" }, "contentRelationship": { "type": "string" }, "contentRelationshipFilePath": { "type": "string" }, "pictureCrossRef": { "type": "string" }, "pictureCrossRefFilePath": { "type": "string" }, "picture2CrossRef": { "type": "string" }, "picture2CrossRefFilePath": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "gloss": { "type": "string" }, "glossl10n": { "type": "string" }, "speaker": { "type": "string" }, "useAvatarOrUserAsSpeaker": { "type": "boolean" }, "speakerImagePath": { "type": "string" }, "addressee": { "type": "string" }, "addresseeImagePath": { "type": "string" }, "section": { "enum": [ "Grammar", "Application", "FluencyDrill", "Reading" ], "type": "string", "nullable": true }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "topicName": { "type": "string" }, "problem": { "type": "integer", "format": "int32", "nullable": true }, "wordBank": { "type": "string" }, "fluencyParadigm": { "type": "string" }, "readingComprehensionTitle": { "type": "string" }, "readingStoryImageFileName": { "type": "string" }, "readingStoryImagePath": { "type": "string" }, "readingStoryImageLabel": { "type": "string" }, "questionPart1": { "type": "string" }, "questionPart2": { "type": "string" }, "story": { "type": "string" }, "questionPrompts": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestQuestionPromptResponse" } }, "pronunciations": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestGrammarPronunciationResponse" } }, "symbols": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestGrammarSymbolResponse" } }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestGrammarCorrectAnswerResponse" } }, "incorrectAnswers": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestGrammarIncorrectAnswerResponse" } } }, "additionalProperties": false }, "GetGrammarLatestVersionResponse": { "type": "object", "properties": { "fileType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "version": { "type": "integer", "format": "int32" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestGrammarEntryResponse" } } }, "additionalProperties": false }, "GetGrammarLatestVersionResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetGrammarLatestVersionResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetGrammarResourcesResponse": { "type": "object", "properties": { "lessonNumber": { "type": "integer", "format": "int32" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "videoFilePath": { "type": "string" }, "culture": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "GetGrammarResourcesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetGrammarResourcesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestCulturesResponse": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": "string" } }, "additionalProperties": false }, "GetLatestCulturesResponseIEnumerableBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestCulturesResponse" } }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetLatestCultureResourcesResponse": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false }, "GetLatestResourcesResponse": { "type": "object", "properties": { "code": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/GetLatestCultureResourcesResponse" } } }, "additionalProperties": false }, "GetLatestResourcesResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLatestResourcesResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "SyncSessionLogsRequestSvcModel": { "type": "object", "properties": { "loginTime": { "type": "string", "format": "date-time", "nullable": true }, "logoutTime": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "SyncLatestSessionLogsRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncSessionLogsRequestSvcModel" } } }, "additionalProperties": false }, "SyncActivityAnswerRequestSvcModel": { "type": "object", "properties": { "answer": { "type": "string" }, "isExact": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "filePath": { "type": "string" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonLogRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "startedOn": { "type": "string", "format": "date-time" }, "finishedOn": { "type": "string", "format": "date-time" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonPointRequestSvcModel": { "type": "object", "properties": { "point": { "type": "number", "format": "double" }, "isDoublePoint": { "type": "boolean" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "rewardedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonStageActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "isMoreOptions": { "type": "boolean" }, "noOfOptions": { "type": "integer", "format": "int32", "nullable": true }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "showIntroduction": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "fileVersion": { "type": "integer", "format": "int32" }, "isReattempt": { "type": "boolean" }, "isRetake": { "type": "boolean" }, "isResumed": { "type": "boolean" }, "resumedOn": { "type": "string", "format": "date-time", "nullable": true }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonAttemptRequestSvcModel" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonLogRequestSvcModel" } }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonPointRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonStageRequestSvcModel": { "type": "object", "properties": { "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "phase": { "enum": [ "Vocabulary", "Grammar", "FinalAct" ], "type": "string" }, "order": { "type": "integer", "format": "int32" }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "topicName": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isActivitiesCreated": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isResumed": { "type": "boolean" }, "resumedOn": { "type": "string", "format": "date-time", "nullable": true }, "lessonStageActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonStageActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncFluencyDrillActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "filePath": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncFluencyDrillActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "fileVersion": { "type": "integer", "format": "int32" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "isReattempt": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isRetake": { "type": "boolean" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDrillActivityAttemptRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncFluencyDrillRequestSvcModel": { "type": "object", "properties": { "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isRetake": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "fluencyDrillActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDrillActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingCompreActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "filePath": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingCompreActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "fileVersion": { "type": "integer", "format": "int32" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "isReattempt": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isRetake": { "type": "boolean" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingCompreActivityAttemptRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingCompreRequestSvcModel": { "type": "object", "properties": { "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isRetake": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "readingComprehensionActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingCompreActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonRequestSvcModel": { "type": "object", "properties": { "level": { "type": "integer", "format": "int32" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isStagesCreated": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "lockedOn": { "type": "string", "format": "date-time", "nullable": true }, "unlockedOn": { "type": "string", "format": "date-time", "nullable": true }, "reattempt": { "type": "integer", "format": "int32" }, "isResumed": { "type": "boolean" }, "resumedOn": { "type": "string", "format": "date-time", "nullable": true }, "isPassedTest": { "type": "boolean" }, "testPassedOn": { "type": "string", "format": "date-time", "nullable": true }, "lessonStages": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonStageRequestSvcModel" } }, "fluencyDrills": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDrillRequestSvcModel" } }, "readingComprehensions": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingCompreRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestLearningRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonRequestSvcModel" } } }, "additionalProperties": false }, "SyncPlacementTestActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "filePath": { "type": "string" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "isArchived": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncPlacementTestActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isReattempt": { "type": "boolean" }, "isRetake": { "type": "boolean" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPlacementTestActivityAttemptRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncPlacementTestRequestSvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isReattempt": { "type": "boolean" }, "placementTestActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPlacementTestActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestPlacementTestsRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPlacementTestRequestSvcModel" } } }, "additionalProperties": false }, "SyncFluencyDeckActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "filePath": { "type": "string" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncFluencyDeckActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "fileVersion": { "type": "integer", "format": "int32" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "isReattempt": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isRetake": { "type": "boolean" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDeckActivityAttemptRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncFluencyDeckRequestSvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "deckType": { "enum": [ "Lesson", "Other" ], "type": "string" }, "isPractice": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "stage": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isStagesCreated": { "type": "boolean" }, "isPreventFromPractice": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "fluencyDrillDeckActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDeckActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestFluencyDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncFluencyDeckRequestSvcModel" } } }, "additionalProperties": false }, "SyncReadingDeckActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "filePath": { "type": "string" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingDeckActivityRequestSvcModel": { "type": "object", "properties": { "order": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "lessonMode": { "enum": [ "Exam", "Retake" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "fileVersion": { "type": "integer", "format": "int32" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "isReattempt": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "isRetake": { "type": "boolean" }, "answers": { "type": "array", "items": { "$ref": "#/components/schemas/SyncActivityAnswerRequestSvcModel" } }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingDeckActivityAttemptRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingDeckRequestSvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "deckType": { "enum": [ "Lesson", "Other" ], "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "stage": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isStagesCreated": { "type": "boolean" }, "isPreventFromPractice": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "readingDeckActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingDeckActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestReadingDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingDeckRequestSvcModel" } } }, "additionalProperties": false }, "SyncDeckStageActivityAttemptRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "attemptedOn": { "type": "string", "format": "date-time" }, "attemptedValue": { "type": "string" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isPronunciationMistake": { "type": "boolean" }, "isSpeakingUsed": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "filePath": { "type": "string" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncDeckStageActivityPointRequestSvcModel": { "type": "object", "properties": { "point": { "type": "number", "format": "double" }, "isDoublePoint": { "type": "boolean" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "rewardedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncDeckStageActivityLogRequestSvcModel": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "int32" }, "isSuccess": { "type": "boolean" }, "isSpellingMistake": { "type": "boolean" }, "isWordBankUsed": { "type": "boolean" }, "startedOn": { "type": "string", "format": "date-time" }, "finishedOn": { "type": "string", "format": "date-time" }, "lessonReattempt": { "type": "integer", "format": "int32" }, "stageReattempt": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncDeckStageActivityRequestSvcModel": { "type": "object", "properties": { "reference": { "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "deckName": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "senseID": { "type": "string" }, "isAlphabet": { "type": "boolean" }, "deckType": { "enum": [ "Lesson", "Preset", "Custom", "WordsNeedPractise" ], "type": "string", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "isMoreOptions": { "type": "boolean" }, "noOfOptions": { "type": "integer", "format": "int32", "nullable": true }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isNewWord": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isQuestionRaised": { "type": "boolean" }, "isSkipped": { "type": "boolean" }, "skippedOn": { "type": "string", "format": "date-time", "nullable": true }, "isReattempt": { "type": "boolean" }, "isRetake": { "type": "boolean" }, "primaryAnswer": { "type": "string" }, "alternateAnswers": { "type": "string" }, "attempts": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckStageActivityAttemptRequestSvcModel" } }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckStageActivityPointRequestSvcModel" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckStageActivityLogRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncDeckStageRequestSvcModel": { "type": "object", "properties": { "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string" }, "phase": { "enum": [ "Vocabulary", "Grammar", "FinalAct" ], "type": "string" }, "order": { "type": "integer", "format": "int32" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isActivitiesCreated": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "learningDeckStageActivities": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckStageActivityRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncDeckRequestSvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "deckType": { "enum": [ "Lesson", "Preset", "Custom", "WordsNeedPractise" ], "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "group": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "order": { "type": "integer", "format": "int32" }, "stage": { "type": "integer", "format": "int32", "nullable": true }, "stack": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "isAlphabet": { "type": "boolean" }, "isGenerated": { "type": "boolean" }, "isCustomDeck": { "type": "boolean" }, "isSharedByUser": { "type": "boolean" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "lastAccessedOn": { "type": "string", "format": "date-time", "nullable": true }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isStagesCreated": { "type": "boolean" }, "reattempt": { "type": "integer", "format": "int32" }, "learningDeckStages": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckStageRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestCustomDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckRequestSvcModel" } } }, "additionalProperties": false }, "SyncUserCustomDeckEntrySenseExampleRequestSvcModel": { "type": "object", "properties": { "verse": { "type": "string" }, "reference": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomDeckEntrySenseIllustrationRequestSvcModel": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomDeckEntrySensePronunciationRequestSvcModel": { "type": "object", "properties": { "filePath": { "type": "string" }, "fileName": { "type": "string" }, "hebrewPronunciation": { "enum": [ "Biblical", "Modern" ], "type": "string", "nullable": true }, "greekPronunciation": { "enum": [ "Erasmian", "Koine", "Modern", "EarlyHighKoine" ], "type": "string", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomDeckEntrySenseRequestSvcModel": { "type": "object", "properties": { "senseID": { "type": "string" }, "gloss": { "type": "string" }, "definition": { "type": "string" }, "semanticDomain": { "type": "string" }, "senseFormLesson": { "type": "string" }, "senseFormDictionary": { "type": "string" }, "isNewlyAdded": { "type": "boolean" }, "examples": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckEntrySenseExampleRequestSvcModel" } }, "illustrations": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckEntrySenseIllustrationRequestSvcModel" } }, "pronunciations": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckEntrySensePronunciationRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomDeckEntryRequestSvcModel": { "type": "object", "properties": { "text": { "type": "string" }, "entryId": { "type": "string" }, "entryRefId": { "type": "string" }, "strongsNumber": { "type": "string" }, "senses": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckEntrySenseRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomDeckRequestSvcModel": { "type": "object", "properties": { "isGenerated": { "type": "boolean" }, "isCustomDeck": { "type": "boolean" }, "isSharedByUser": { "type": "boolean" }, "sharedByUserRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string" }, "origDeckName": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "customDeckEntries": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckEntryRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncUserCustomGroupRequestSvcModel": { "type": "object", "properties": { "group": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "isShared": { "type": "boolean" }, "customDecks": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomDeckRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestUserCustomDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncUserCustomGroupRequestSvcModel" } } }, "additionalProperties": false }, "SyncLatestPresetDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckRequestSvcModel" } } }, "additionalProperties": false }, "SyncLatestPracticeDecksRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncDeckRequestSvcModel" } } }, "additionalProperties": false }, "SyncLatestSharedDeckRequest": { "type": "object", "properties": { "group": { "type": "string" }, "deckName": { "type": "string" }, "shareDeckByParam": { "type": "string" }, "shareDeckByType": { "enum": [ "ClassroomCode", "Email" ], "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" } }, "additionalProperties": false }, "SyncSpacedRepRequestSvcModel": { "type": "object", "properties": { "lessonStageActivityRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "learningDeckStageActivityRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "reference": { "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "word": { "type": "string" }, "strongsNumber": { "type": "string" }, "deckName": { "type": "string" }, "senseID": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "isAlphabet": { "type": "boolean" }, "isNewWord": { "type": "boolean" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "deckType": { "enum": [ "Lesson", "Preset", "Custom", "WordsNeedPractise" ], "type": "string" }, "stage": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "stack": { "type": "integer", "format": "int32" }, "isStarted": { "type": "boolean" }, "startedOn": { "type": "string", "format": "date-time", "nullable": true }, "isCompleted": { "type": "boolean" }, "completedOn": { "type": "string", "format": "date-time", "nullable": true }, "isArchived": { "type": "boolean" }, "isWordArchived": { "type": "boolean" }, "archivedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestSpacedRepetitionsRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncSpacedRepRequestSvcModel" } } }, "additionalProperties": false }, "SyncSpacedRepFluencyDrillsRequestSvcModel": { "type": "object", "properties": { "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "deckType": { "enum": [ "Lesson", "Other" ], "type": "string" }, "name": { "type": "string" }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "stage": { "type": "integer", "format": "int32" }, "isArchived": { "type": "boolean" }, "isDeckArchived": { "type": "boolean" }, "archivedOn": { "type": "string", "format": "date-time", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestSpacedRepFluencyDrillsRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncSpacedRepFluencyDrillsRequestSvcModel" } } }, "additionalProperties": false }, "SyncQuestionRequestSvcModel": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "questionRefNo": { "type": "string" }, "questionType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "refID": { "type": "string" }, "fileVersion": { "type": "integer", "format": "int32" }, "phase": { "enum": [ "Vocabulary", "Grammar", "FinalAct" ], "type": "string", "nullable": true }, "stage": { "enum": [ "VocabularyAssociation", "VocabularyPassive", "VocabularyActive", "Game", "GrammarAssociation", "GrammarPassive", "GrammarActive", "FinalAct" ], "type": "string", "nullable": true }, "topic": { "type": "integer", "format": "int32", "nullable": true }, "lessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "mainLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "subLessonNumber": { "type": "integer", "format": "int32", "nullable": true }, "deckName": { "type": "string" }, "learningMode": { "enum": [ "Lesson", "Deck" ], "type": "string" }, "word": { "type": "string" }, "strongsNumber": { "type": "string" }, "orderingLocation": { "type": "string" }, "askedOn": { "type": "string", "format": "date-time" }, "isDuplicate": { "type": "boolean" }, "lessonStageActivityRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "learningDeckStageActivityRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "fluencyDrillActivityRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestQuestionsRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncQuestionRequestSvcModel" } } }, "additionalProperties": false }, "SyncLessonPlanTrackingRequestSvcModel": { "type": "object", "properties": { "lessonNumber": { "type": "integer", "format": "int32" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLessonPlanRequestSvcModel": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "name": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "planType": { "enum": [ "LessonGoals", "ReadingGoals", "PracticeGoals" ], "type": "string" }, "pace": { "type": "integer", "format": "int32" }, "daysOfWeek": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "lessonPlanTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonPlanTrackingRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestLessonPlansRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncLessonPlanRequestSvcModel" } } }, "additionalProperties": false }, "SyncPracticePlanTrackingRequestSvcModel": { "type": "object", "properties": { "endDate": { "type": "string", "format": "date-time" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncPracticePlanModuleRequestSvcModel": { "type": "object", "properties": { "moduleType": { "enum": [ "CustomDeck", "BibleReading", "FluencyDrill", "WordsThatNeedPractice" ], "type": "string" }, "pace": { "type": "integer", "format": "int32" }, "practiceGoalsPlanTrackings": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPracticePlanTrackingRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncPracticePlanRequestSvcModel": { "type": "object", "properties": { "name": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "planType": { "enum": [ "LessonGoals", "ReadingGoals", "PracticeGoals" ], "type": "string" }, "daysOfWeek": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "practicePlanModules": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPracticePlanModuleRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestPracticePlansRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncPracticePlanRequestSvcModel" } } }, "additionalProperties": false }, "SyncReadingPlanTrackingRequestSvcModel": { "type": "object", "properties": { "bookRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "chapter": { "type": "integer", "format": "int32" }, "verseFrom": { "type": "integer", "format": "int32" }, "verseTo": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "status": { "enum": [ "NotStarted", "InProgress", "Completed" ], "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncReadingPlanRequestSvcModel": { "type": "object", "properties": { "startBookRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "endBookRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "startChapter": { "type": "integer", "format": "int32" }, "endChapter": { "type": "integer", "format": "int32" }, "applicationUserRowUniqueId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "planType": { "enum": [ "LessonGoals", "ReadingGoals", "PracticeGoals" ], "type": "string" }, "daysOfWeek": { "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "trackings": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingPlanTrackingRequestSvcModel" } }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestReadingPlansRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncReadingPlanRequestSvcModel" } } }, "additionalProperties": false }, "SyncClassroomStudentRequestSvcModel": { "type": "object", "properties": { "classroomCode": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdatedOn": { "type": "string", "format": "date-time", "nullable": true }, "rowUniqueId": { "type": "string", "format": "uuid" }, "isDeleted": { "type": "boolean" } }, "additionalProperties": false }, "SyncLatestClassroomStudentRequest": { "type": "object", "properties": { "platform": { "type": "string" }, "deviceName": { "type": "string" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "request": { "type": "array", "items": { "$ref": "#/components/schemas/SyncClassroomStudentRequestSvcModel" } } }, "additionalProperties": false }, "GetClassLessonsResponse": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "content": { "enum": [ "Words", "Sentences", "Stories", "Alphabet" ], "type": "string" }, "benchmark": { "type": "integer", "format": "int32" }, "totalStudents": { "type": "integer", "format": "int32" }, "progress": { "$ref": "#/components/schemas/ClassProgressModel" }, "lessons": { "type": "array", "items": { "$ref": "#/components/schemas/ClassLessonRowModel" } } }, "additionalProperties": false }, "GetClassLessonsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetClassLessonsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "LessonStudentModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string" }, "score": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string" } }, "additionalProperties": false }, "GetLessonStudentsResponse": { "type": "object", "properties": { "classRoomId": { "type": "integer", "format": "int64" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "mainLessonNumber": { "type": "integer", "format": "int32" }, "subLessonNumber": { "type": "integer", "format": "int32" }, "content": { "enum": [ "Words", "Sentences", "Stories", "Alphabet" ], "type": "string" }, "mode": { "enum": [ "Learn", "Retain", "Fluency" ], "type": "string" }, "benchmark": { "type": "integer", "format": "int32" }, "students": { "type": "array", "items": { "$ref": "#/components/schemas/LessonStudentModel" } } }, "additionalProperties": false }, "GetLessonStudentsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetLessonStudentsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "GetTutorialsResponse": { "type": "object", "properties": { "title": { "type": "string" }, "filePath": { "type": "string" } }, "additionalProperties": false }, "GetTutorialsResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/GetTutorialsResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false }, "UploadVocabularyResponse": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "language": { "enum": [ "Hebrew", "Greek", "Latin", "Aramaic", "English" ], "type": "string" }, "fileType": { "enum": [ "Grammar", "Vocabulary" ], "type": "string" }, "fileName": { "type": "string" }, "isSuccess": { "type": "boolean" }, "successEntryCount": { "type": "integer", "format": "int32" }, "failedCount": { "type": "integer", "format": "int32" }, "successEntries": { "type": "array", "items": { "type": "string" } }, "failedEntries": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "UploadVocabularyResponseBiblingoAPIResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" }, "response": { "$ref": "#/components/schemas/UploadVocabularyResponse" }, "traceId": { "type": "string" } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "JWT Authorization header using the Bearer scheme. Example: \"Bearer {token}\"", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }