Org Web Adapter

Editing pages/learnupon_api.org

:PROPERTIES:
:ID:       7ab85ceb-8d51-44b2-b161-609cdd4a09a9
:END:
#+title: LearnUpon API

- tags :: [[id:e1f0844a-1193-4e44-9a8c-688c4858ddf0][LearnUpon]] [[id:b08ac197-337b-4392-84d5-98eaead61400][15Five]] [[id:92f7c725-8fa8-446e-8a08-22e89eba47b7][API]]

* Basic user fetching
#+begin_src restclient
GET https://fifteenfive.learnupon.com/api/v1/users
Content-Type: application/json
Authorization: Basic ZTI1YWJmYTgzN2IyZjUzZTdjMmY6ZmY4YjFlMmE1NGYzOWE5YmJhOTE1ZmEyOGZmNjJj
#+end_src

#+RESULTS:
#+BEGIN_SRC js
{
  "customDataFieldDefintions": [
    {
      "id": 35533,
      "type_id": 4,
      "label": "department"
    },
    {
      "id": 35534,
      "type_id": 4,
      "label": "location"
    },
    {
      "id": 35535,
      "type_id": 4,
      "label": "skill_focus"
    },
    {
      "id": 35536,
      "type_id": 4,
      "label": "missed_15five_report"
    }
  ],
  "user": [
    {
      "id": 9087247,
      "first_name": "Simon",
      "last_name": "Turner",
      "email": "15five@luptest.com",
      "sign_in_count": 4,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T12:11:09Z",
      "last_sign_in_at": "2020-12-01T14:42:28Z",
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": null,
      "customDataFieldValues": [],
      "locale": "en",
      "enabled": true,
      "user_type": "admin",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 5,
      "number_of_badges": 2
    },
    {
      "id": 9088408,
      "first_name": "Simon",
      "last_name": "Turner",
      "email": "simon.turner@learnupon.com",
      "sign_in_count": 4,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T14:41:53Z",
      "last_sign_in_at": "2020-12-08T18:26:24Z",
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Partnerships",
        "location": null,
        "skill_focus": "Listening",
        "missed_15five_report": null
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Partnerships"
        },
        {
          "definition_id": 35534,
          "value": null
        },
        {
          "definition_id": 35535,
          "value": "Listening"
        },
        {
          "definition_id": 35536,
          "value": null
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "admin",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 5,
      "number_of_badges": 2
    },
    {
      "id": 9090002,
      "first_name": "Marcia",
      "last_name": "Abbass",
      "email": "Marcia@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Partnerships",
        "location": "Ireland",
        "skill_focus": null,
        "missed_15five_report": "Sometimes"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Partnerships"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Sometimes"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090003,
      "first_name": "Frank",
      "last_name": "Vernon",
      "email": "Frank@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 4,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Partnerships",
        "location": "Ireland",
        "skill_focus": "Listening",
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Partnerships"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": "Listening"
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090004,
      "first_name": "Roman",
      "last_name": "Culkin",
      "email": "Roman@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 4,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Sales",
        "location": "US",
        "skill_focus": "Listening",
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Sales"
        },
        {
          "definition_id": 35534,
          "value": "US"
        },
        {
          "definition_id": 35535,
          "value": "Listening"
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090005,
      "first_name": "Kendall",
      "last_name": "Strong",
      "email": "Kendall@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Sales",
        "location": "US",
        "skill_focus": null,
        "missed_15five_report": null
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Sales"
        },
        {
          "definition_id": 35534,
          "value": "US"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": null
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090006,
      "first_name": "Siobhan",
      "last_name": "Snook",
      "email": "Siobhan@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Sales",
        "location": "US",
        "skill_focus": null,
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Sales"
        },
        {
          "definition_id": 35534,
          "value": "US"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090007,
      "first_name": "Connor",
      "last_name": "Roy",
      "email": "Connor@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Product",
        "location": "Ireland",
        "skill_focus": null,
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Product"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "manager",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090008,
      "first_name": "Jess",
      "last_name": "Jordan",
      "email": "Jess@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Product",
        "location": "Ireland",
        "skill_focus": null,
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Product"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090009,
      "first_name": "Rhea",
      "last_name": "Hunter",
      "email": "Rhea@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 4,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Partnerships",
        "location": "US",
        "skill_focus": "Listening",
        "missed_15five_report": "Sometimes"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Partnerships"
        },
        {
          "definition_id": 35534,
          "value": "US"
        },
        {
          "definition_id": 35535,
          "value": "Listening"
        },
        {
          "definition_id": 35536,
          "value": "Sometimes"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090010,
      "first_name": "Greg",
      "last_name": "Hirsch",
      "email": "Greg@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Product",
        "location": "Ireland",
        "skill_focus": null,
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Product"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9090011,
      "first_name": "Michelle",
      "last_name": "Pantsil",
      "email": "Michelle@15Five.luptest.com",
      "sign_in_count": 0,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T16:25:03Z",
      "last_sign_in_at": null,
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": "Product",
        "location": "Ireland",
        "skill_focus": null,
        "missed_15five_report": "Never"
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": "Product"
        },
        {
          "definition_id": 35534,
          "value": "Ireland"
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": "Never"
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "learner",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9091463,
      "first_name": "Cathal",
      "last_name": "Small",
      "email": "Cathal.small@learnupon.com",
      "sign_in_count": 1,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-01T18:25:58Z",
      "last_sign_in_at": "2020-12-01T18:25:59Z",
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": null,
        "location": null,
        "skill_focus": null,
        "missed_15five_report": null
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": null
        },
        {
          "definition_id": 35534,
          "value": null
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": null
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "admin",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9230502,
      "first_name": "Bradon",
      "last_name": "Fennell",
      "email": "bradon.fennell@15five.com",
      "sign_in_count": 1,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-08T16:49:30Z",
      "last_sign_in_at": "2020-12-08T16:49:30Z",
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": null,
        "location": null,
        "skill_focus": null,
        "missed_15five_report": null
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": null
        },
        {
          "definition_id": 35534,
          "value": null
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": null
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "admin",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 0,
      "number_of_badges": 0
    },
    {
      "id": 9250320,
      "first_name": "Colin",
      "last_name": "Powell",
      "email": "colin.powell@15five.com",
      "sign_in_count": 2,
      "number_of_enrollments": 3,
      "number_of_enrollments_accessed": 0,
      "created_at": "2020-12-08T23:09:36Z",
      "last_sign_in_at": "2020-12-09T02:36:51Z",
      "account_expires": null,
      "sf_user_id": null,
      "sf_contact_id": null,
      "is_salesforce_contact": 0,
      "CustomData": {
        "department": null,
        "location": null,
        "skill_focus": null,
        "missed_15five_report": null
      },
      "customDataFieldValues": [
        {
          "definition_id": 35533,
          "value": null
        },
        {
          "definition_id": 35534,
          "value": null
        },
        {
          "definition_id": 35535,
          "value": null
        },
        {
          "definition_id": 35536,
          "value": null
        }
      ],
      "locale": "en",
      "enabled": true,
      "user_type": "admin",
      "can_enroll": true,
      "can_delete_users": false,
      "can_unenroll_users": false,
      "can_move_groups": false,
      "can_mark_complete": false,
      "tutor_can_edit_their_courses": true,
      "tutor_can_create_courses": false,
      "number_of_points": 5,
      "number_of_badges": 2
    }
  ]
}
// GET https://fifteenfive.learnupon.com/api/v1/users
// HTTP/1.1 200 OK
// Cache-Control: max-age=0, private, must-revalidate
// Content-Type: application/json; charset=utf-8
// Date: Wed, 09 Dec 2020 04:31:47 GMT
// ETag: W/"bb3ae6322394fe76b33834591a13d9b6"
// Expect-CT: enforce, max-age=30
// LU-Current-Page: 1
// LU-Has-Next-Page: false
// LU-Records-Per-Page: 500
// P3P: CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"
// Referrer-Policy: strict-origin-when-cross-origin
// Server: nginx
// X-Content-Type-Options: nosniff
// X-Download-Options: noopen
// X-Frame-Options: SAMEORIGIN
// X-LU-Rate-Limit-Remaining-Minute: 99999999
// X-LU-Rate-Limit-Remaining-Week: 249999999996
// X-Permitted-Cross-Domain-Policies: none
// X-Request-Id: 54b261b4-4737-409f-a1a9-63a5ef2a1bb0
// X-Runtime: 0.051050
// X-XSS-Protection: 1; mode=block
// transfer-encoding: chunked
// Connection: keep-alive
// Request duration: 0.833980s
#+END_SRC

#+begin_src restclient
GET https://fifteenfive.learnupon.com/api/v1/courses
Content-Type: application/json
Authorization: Basic ZTI1YWJmYTgzN2IyZjUzZTdjMmY6ZmY4YjFlMmE1NGYzOWE5YmJhOTE1ZmEyOGZmNjJj
#+end_src

#+RESULTS:
#+begin_example
,#+BEGIN_SRC js
{
  "response_type": "ERROR",
  "response_code": 401,
  "message": "not authorised"
}
// GET https://fifteenfive.learnupon.com/api/v1/courses
// HTTP/1.1 401 Unauthorized
// Cache-Control: no-cache
// Content-Type: text/javascript; charset=utf-8
// Date: Thu, 11 Feb 2021 18:30:55 GMT
// Expect-CT: enforce, max-age=30
// P3P: CP="NOI ADM DEV PSAi COM NAV OUR OTRo STP IND DEM"
// Referrer-Policy: strict-origin-when-cross-origin
// Server: nginx
// X-Content-Type-Options: nosniff
// X-Download-Options: noopen
// X-Frame-Options: SAMEORIGIN
// X-Permitted-Cross-Domain-Policies: none
// X-Request-Id: 3d252ddd-d229-4da4-8968-10d549fa5b45
// X-Runtime: 0.005844
// X-XSS-Protection: 1; mode=block
// Content-Length: 72
// Connection: keep-alive
// Request duration: 1.004821s
,#+END_SRC
#+end_example