Welcome to the BETA-LMS API! This documentation provides details on how
to interact with the BETA-LMS platform through its API endpoints using
Postman.
This endpoint is used to reset a user's password.
\nUpon successful password reset, the API returns a status code of 200 and a message confirming the password reset.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["student","register"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d58e27b6-401d-4634-b1e8-2baae6465fe4"},{"name":"Verify OTP using email","event":[{"listen":"test","script":{"id":"1aa7cb58-f07f-41c1-beaf-9c9eb4b4654f","exec":["// Stores the message in an environment or global variable","var logoutMessage = pm.response.json().message;","pm.globals.set(\"logoutMessage\", logoutMessage);"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"4f9d342f-9b1a-46f6-8e82-e31fcdf268e1","exec":[""],"type":"text/javascript"}}],"id":"78193a99-edad-469b-90e4-87a9e150f27d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"foo@bar.comss\",\n \"otp\": \"7675\"\n}","options":{"raw":{"language":"json"}}},"url":"http://lms-api.ping/api/email-otp-verification","description":"This endpoint is used to reset a user's password.
\nUpon successful password reset, the API returns a status code of 200 and a message confirming the password reset.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["email-otp-verification"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"78193a99-edad-469b-90e4-87a9e150f27d"},{"name":"Resend OTP using email","id":"95865c95-d3fd-4931-94ed-3cc97e10878c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"foo@bar.com\"\n}","options":{"raw":{"language":"json"}}},"url":"http://lms-api.ping/api/resend/email-otp-verification","description":"This endpoint triggers a request to resend the email OTP verification. The request should be sent via an HTTP GET method to the specified URL.
\nThe request should include the following payload in the raw request body type:
\n{\n \"email\": \"string\"\n}\nemail: (string) The email address to which the OTP verification will be resent.Upon successful execution, the response will have a status code of 200 and the following content:
\n{\n \"success\": true,\n \"message\": \"string\"\n}\nsuccess: (boolean) Indicates whether the OTP verification resend was successful.message: (string) A message confirming the status of the OTP resend operation.| User ID | ","Name | ","Role ID | ","|
|---|---|---|---|
| {{response.user.id}} | ","{{response.user.name}} | ","{{response.user.email}} | ","{{response.user.role_id}} | ","
This endpoint is used to authenticate and log in a user.
\nThis endpoint makes an HTTP GET request to retrieve user information.
\nThe request should be made to http://lms-api.ping/api/user using the form-data request body type with the following parameters:
email (text) - The email of the user.password (text) - The password of the user.Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the following structure:
\n{\n \"data\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"is_super\": null,\n \"role_id\": 0,\n \"roles\": [\"\"],\n \"permissions\": [\"\"]\n }\n}\n\nThe data object contains user information including id, name, email, is_super status, role_id, roles, and permissions.
This endpoint makes an HTTP GET request to retrieve user information.
\nThe request should be made to http://lms-api.ping/api/user using the form-data request body type with the following parameters:
email (text) - The email of the user.password (text) - The password of the user.Upon successful execution, the endpoint returns a status code of 200 and a JSON response with the following structure:
\n{\n \"data\": {\n \"id\": 0,\n \"name\": \"\",\n \"email\": \"\",\n \"is_super\": null,\n \"role_id\": 0,\n \"roles\": [\"\"],\n \"permissions\": [\"\"]\n }\n}\n\nThe data object contains user information including id, name, email, is_super status, role_id, roles, and permissions.
This endpoint allows you to send a POST request to http://lms-api.ping/api/password/email in order to initiate the process of resetting a user's password. The request should include the user's email as a form-data parameter.
\nUpon successful execution, the endpoint will return a 200 status code along with a JSON object containing a message indicating the status of the password reset initiation.
\nExample:
\n{\n \"message\": \"...\"\n}\n\nThis endpoint is used to reset a user's password.
\nUpon successful password reset, the API returns a status code of 200 and a message confirming the password reset.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["password","reset"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"303567ea-3f83-4a82-8045-ac656fb6fa55"},{"name":"Destroy token","event":[{"listen":"test","script":{"id":"1aa7cb58-f07f-41c1-beaf-9c9eb4b4654f","exec":["// Stores the message in an environment or global variable","var logoutMessage = pm.response.json().message;","pm.globals.set(\"logoutMessage\", logoutMessage);"],"type":"text/javascript"}}],"id":"5f2d48ef-bd3b-41d6-a9c3-4bcb68a87dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://lms-api.ping/api/logout","description":"This endpoint is used to log out a user from the system. Upon successful execution, it returns a status code of 200 with an empty message in the response body.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["logout"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f2d48ef-bd3b-41d6-a9c3-4bcb68a87dfa"},{"name":"Login using Social Networks (e.g. google)","id":"85dcf6c2-c738-496e-a794-ab8d7af14cb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://lms-api.ping/api/authorize/:provider/redirect","description":"This endpoint is used to initiate the authorization process with a specific provider by obtaining the redirect URL.
\nThe request does not require a request body, and the HTTP method used is GET.
\nUpon successful execution, the response will include a status code of 200 along with the redirect URL in the JSON format.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["authorize",":provider","redirect"],"host":["http://lms-api.ping/api"],"query":[],"variable":[{"type":"any","value":"google","key":"provider"}]}},"response":[],"_postman_id":"85dcf6c2-c738-496e-a794-ab8d7af14cb5"},{"name":"Response from the Social Networks","id":"46b0b69f-c2ac-4564-a5d5-2a25a1afdc5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://lms-api.ping/api/authorize/:provider/callback","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["authorize",":provider","callback"],"host":["http://lms-api.ping/api"],"query":[],"variable":[{"type":"any","value":"google","key":"provider"}]}},"response":[],"_postman_id":"46b0b69f-c2ac-4564-a5d5-2a25a1afdc5e"},{"name":"Update user profile","id":"547f5219-24e9-48cd-8b2f-6bcbbb26c7cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Foo Bar\",\n \"email\": \"superadmin@gmail.com\",\n \"contact_number\": \"980989s9098\",\n \"infos\": {\n \"gender\": \"n\",\n \"dob\": \"2020-12-12\",\n \"country\": \"nepal\",\n \"planned_destination\": \"canada\",\n \"course_interested_for\": \"ielts\",\n \"is_test_booked\": \"\",\n \"purpose_of_test\": \"\",\n \"address\": {\n \"permanent_address\": \"perm\",\n \"current_address\": \"nepal\"\n },\n \"guardian\": {\n \"name\": \"test\",\n \"occupation\": \"\"\n },\n \"emergency_number\": \"test\",\n \"qualification\": {\n \"level\": \"test\",\n \"institution\": \"test\",\n \"score\": {\n \"mark\": \"test\",\n \"type\": \"percentage\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://lms-api.ping/api/user/info/update","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["user","info","update"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"547f5219-24e9-48cd-8b2f-6bcbbb26c7cd"},{"name":"Update password","id":"c0053025-d06b-4848-a7c4-9a5a495b81d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Requested-With","value":"XMLHttpRequest","type":"text"}],"body":{"mode":"raw","raw":"{\n \"current_password\": \"password\",\n \"new_password\": \"secret\",\n \"new_password_confirmation\": \"secret\"\n}","options":{"raw":{"language":"json"}}},"url":"http://lms-api.ping/api/update-password","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","name":"Authentication","type":"folder"}},"urlObject":{"path":["update-password"],"host":["http://lms-api.ping/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0053025-d06b-4848-a7c4-9a5a495b81d3"}],"id":"0bf74fc3-433e-42c8-8ac3-61b194c06e34","description":"To access the BETA-LMS API, you need to obtain an API key by registering
on the BETA-LMS platform. The API key should be included in the headers
of your requests for authentication.