Api doc


SDK's


Api Modules

training.module

Manage an individual training module



Supported Methods:

GET
Params
  • token (Required): valid token
  • id (Required): integer
  • store: integer


UPDATE
Params
  • token (Required): valid token
  • id (Required): integer
  • title: varchar
  • duedate: date
  • est_time: date
  • section: integer
  • child_edit: integer
  • tutorial: integer
  • mintime: integer
  • contents: varchar
  • video: varchar
  • addgroup: integer
  • removegroup: integer
  • add_group: integer
  • remove_group: integer
  • add_skill: integer
  • remove_skill: integer
  • add_user_training: integer
  • iframe: varchar
  • remove_user_training: integer
  • addlocation: integer
  • removelocation: integer
  • reset: integer
  • silent: integer
  • comment_type: integer
  • can_see_comment: integer
  • digital_signature: integer
  • download_pdf: integer
  • questions: enum (Array)


DELETE
Params
  • token (Required): valid token
  • id (Required): integer


CREATE
Params
  • token (Required): valid token
  • title (Required): varchar
  • section: integer
  • tutorial: integer
  • mintime: integer
  • contents: varchar
  • video: varchar
  • iframe: varchar


Documentation

GET
Retrieves an individual training module.
Level 5 is required (all users can fetch this module)

--

Parameters:

  1. "id": required //We use this parameter to specify module by id (integer)
  2. "store": accepted //Store id (integer)
  3. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"GET",
  3. "module":"training.module",
  4. "request":{
  5. "id":"36"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"24",
  5. "store":"11",
  6. "title":"Admin Account Settings",
  7. "section":"7",
  8. "tutorial":"56",
  9. "contents":"",
  10. "video":"",
  11. "mintime":null,
  12. "deleted":"0",
  13. "deleted_by":"0",
  14. "created":"1334809797",
  15. "created_by":"123",
  16. "updated":"1334810273",
  17. "updated_by":"2",
  18. "child_edit":"1",
  19. "orig_cm_id":"0",
  20. "files":[
  21.  
  22. ],
  23. "stats":{
  24. "totalstaff":0,
  25. "finished":0,
  26. "unfinished":0,
  27. "outdated":0
  28. }
  29. },
  30. "token":"xxxxxxx"
  31. }

---

CREATE
Create an individual training module.
Level 3 is required.

--

Parameters:

  1. "title": required //Title (varchar)
  2. "sections": accepted //Section (integer)
  3. "tutorial": accepted //Tutorial (integer)
  4. "mintime": accepted //Mintime (integer)
  5. "contens": accepted //Contents (varchar)
  6. "video": accepted //Video - Youtube id (varchar)
  7. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"CREATE",
  3. "module":"training.module",
  4. "request":{
  5. "title":"New Title",
  6. "content":"New content"
  7. }
  8. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"56",
  5. "store":"11",
  6. "title":"New title",
  7. "section":"7",
  8. "tutorial":"56",
  9. "contents":"New content",
  10. "video":"",
  11. "mintime":null,
  12. "deleted":"0",
  13. "deleted_by":"0",
  14. "created":"1334809797",
  15. "created_by":"123",
  16. "updated":"1334810273",
  17. "updated_by":"2",
  18. "child_edit":"1",
  19. "orig_cm_id":"0",
  20. "files":[
  21.  
  22. ],
  23. "stats":{
  24. "totalstaff":0,
  25. "finished":0,
  26. "unfinished":0,
  27. "outdated":0
  28. }
  29. },
  30. "token":"xxxxxxx"
  31. }

---

UPDATE
Update an individual training module.
Level 3 is required.

--

Parameters:

  1. "id": required //Module id (integer)
  2. "title": accepted //Title (varchar)
  3. "child_edit": accepted //Child edit (integer)
  4. "section": accepted //Section (integer)
  5. "tutorial": accepted //Tutorial (integer)
  6. "mintime": accepted //Mintime (integer)
  7. "contents": accepted //Contents (varchar)
  8. "video": accepted //Video - Youtube id (varchar)
  9. "addgroup": accepted //Add group by id(integer)
  10. "removegroup": accepted //Remove group by id(integer)
  11. "add_group": accepted //Add group by id (integer)
  12. "remove_group": accepted //Remove group by id (integer)
  13. "add_skill": accepted //Add skill by id(integer)
  14. "remove_skill": accepted //Remove skill by id(integer)
  15. "add_user_training": accepted //Add user training by id(integer)
  16. "remove_user_training": accepted //Remove user training by id(integer)
  17. "addlocation": accepted //Add location by id(integer)
  18. "removelocation": accepted //Remove location by id(integer)
  19. "reset": accepted //Reset (integer)
  20. /* null : Do nothing
  21.   * isset: Reset */
  22. "silent": accepted //Silent (integer)
  23. /* null : Do nothing
  24.   /* isset: Silent */
  25. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"UPDATE",
  3. "module":"training.module",
  4. "request":{
  5. "id":"56",
  6. "title":"New Title 2",
  7. "content":"New content 2"
  8. }
  9. }

Example Response:

  1. {
  2. "status":1,
  3. "data":{
  4. "id":"56",
  5. "store":"11",
  6. "title":"New title 2",
  7. "section":"7",
  8. "tutorial":"56",
  9. "contents":"New content 2",
  10. "video":"",
  11. "mintime":null,
  12. "deleted":"0",
  13. "deleted_by":"0",
  14. "created":"1334809797",
  15. "created_by":"123",
  16. "updated":"1334810273",
  17. "updated_by":"2",
  18. "child_edit":"1",
  19. "orig_cm_id":"0",
  20. "files":[
  21.  
  22. ],
  23. "stats":{
  24. "totalstaff":0,
  25. "finished":0,
  26. "unfinished":0,
  27. "outdated":0
  28. }
  29. },
  30. "token":"xxxxxxx"
  31. }

---

DELETE
Delete an individual training module.
Level 3 is required.

--

Parameters:

  1. "id": required //We use this parameter to specify module by id (integer)
  2. "token": "xxxxxxx" //Valid token is required

Example Request:

  1. {
  2. "method":"DELETE",
  3. "module":"training.module",
  4. "request":{
  5. "id":"36"
  6. }
  7. }

Example Response:

  1. {
  2. "status":1,
  3. "data":"",
  4. "token":"xxxxxxx"
  5. }

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close