LearningAPI API

Get myGA Assignments for a specific User

Queries myGA for a page of Assignment records

Parameters

Name	Description
page	Pagination - page number (default 1)
per_page	Pagination - number of records per page (default 10)
type	Filter assignments by type
status	Filter assignments by status

Request

Headers

Authorization: partner_access_token
Accept: application/json
Content-Type: application/json

Route

GET /api/v1/learning/users/%3Auuid/assignments

Response

Headers

Content-Type: application/json
X-Page: 1
X-Per-Page: 2
X-Total-Pages: 1
X-Total: 2

Status

Body

{
  "assignments": [
    {
      "user": {
        "uuid": "56b3604f-93bc-47be-8af5-34b031aeaeb7",
        "external_id": "6b3a6802-17b5-4f0e-ab8b-4479401e40cc",
        "email": "jane.blogs@company.com",
        "first_name": "Jane",
        "last_name": "Blogs",
        "status": "enabled",
        "created_at": "2016-10-02T12:22:11.000+00:00",
        "updated_at": "2016-07-07T06:53:12.000+00:00"
      },
      "type": "path",
      "title": "Introduction to Marketing",
      "description": "Learn so much about marketing.",
      "purpose": "prework",
      "duration": 260,
      "url": "https://my.ga.co/assignment/66b3604f-93bc-47be-8af5-34b031aeaeb8",
      "status": "not_started",
      "start_date": "2018-02-02T12:22:11.000+00:00",
      "end_date": "2018-07-07T06:53:12.000+00:00",
      "started_at": null,
      "completed_at": null,
      "path_info": {
        "content": [
          "46b3604f-33bc-47be-8af5-34b031aeaeb8",
          "86b3604f-93bc-47be-8a45-24b031aeaeb0"
        ]
      }
    },
    {
      "user": {
        "uuid": "56b3604f-93bc-47be-8af5-34b031aeaeb7",
        "external_id": "6b3a6802-17b5-4f0e-ab8b-4479401e40cc",
        "email": "jane.blogs@company.com",
        "first_name": "Jane",
        "last_name": "Blogs",
        "status": "enabled",
        "created_at": "2016-10-02T12:22:11.000+00:00",
        "updated_at": "2016-07-07T06:53:12.000+00:00"
      },
      "type": "assessment",
      "title": "Marketing Diagnostic Assessment",
      "description": "How much do you know about marketing.",
      "purpose": "diagnostic",
      "duration": 45,
      "url": "https://my.ga.co/assignment/96b3604f-93bc-47be-8af5-34b031aeaeb8",
      "status": "completed",
      "start_date": "2018-02-02T12:22:11.000+00:00",
      "end_date": "2018-07-07T06:53:12.000+00:00",
      "started_at": "2018-03-03T06:53:12.000+00:00",
      "completed_at": "2018-04-04T06:53:12.000+00:00",
      "assessment_info": {
        "slug": "assessment-slug",
        "total_score": {
          "score": 24,
          "max_score": 30
        },
        "subscores": [
          {
            "type": "Social",
            "name": "MyBookster",
            "score": 3,
            "max_score": 4
          }
        ]
      }
    }
  ]
}