Skip to main content
GET
/
api
/
v1
/
external
/
train
/
user
/
{userId}
/
enrollments
List User Phase Enrollments
curl --request GET \
  --url https://app.govworx.net/api/v1/external/train/user/{userId}/enrollments
[
  {
    "id": 123,
    "tenantId": 123,
    "phaseId": 123,
    "phaseName": "<string>",
    "user": {
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "loginEnabled": true,
      "notificationEmail": "<string>",
      "id": 123,
      "tenantId": 123,
      "idpSub": "<string>",
      "personnelId": "<string>",
      "roleId": 123,
      "mfaEnabled": true,
      "lastLoginAt": "2023-11-07T05:31:56Z",
      "isSupervisor": true,
      "isTemplatePublishingAllowed": true,
      "vlrIdentifier": "<string>",
      "passwordExpiresAt": "2023-11-07T05:31:56Z",
      "isPasswordExpired": true,
      "isSupportUser": true
    },
    "primaryTrainingOfficer": {
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "loginEnabled": true,
      "notificationEmail": "<string>",
      "id": 123,
      "tenantId": 123,
      "idpSub": "<string>",
      "personnelId": "<string>",
      "roleId": 123,
      "mfaEnabled": true,
      "lastLoginAt": "2023-11-07T05:31:56Z",
      "isSupervisor": true,
      "isTemplatePublishingAllowed": true,
      "vlrIdentifier": "<string>",
      "passwordExpiresAt": "2023-11-07T05:31:56Z",
      "isPasswordExpired": true,
      "isSupportUser": true
    },
    "startDate": "2023-12-25",
    "originalPlannedEndDate": "2023-12-25",
    "projectedEndDate": "2023-12-25",
    "actualEndDate": "2023-12-25",
    "status": "SCHEDULED",
    "statusReason": "<string>",
    "signoffId": 123,
    "hasSignoffFlow": true,
    "taskLists": [
      {
        "id": 123,
        "subject": {
          "id": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "notificationEmail": "<string>"
        },
        "primaryTrainingOfficer": {
          "id": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "notificationEmail": "<string>"
        },
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z",
        "enrollmentDate": "2023-11-07T05:31:56Z",
        "status": "IN_PROGRESS",
        "taskListTemplateVersion": {
          "id": 123,
          "active": true,
          "version": 123,
          "columnCount": 123,
          "trainingOfficerOnly": true,
          "items": [
            {
              "id": 123,
              "name": "<string>",
              "orderIndex": 123,
              "parentId": 123
            }
          ],
          "groups": [
            {
              "id": 123,
              "name": "<string>",
              "orderIndex": 123,
              "parentId": 123
            }
          ],
          "name": "<string>",
          "columnLabels": [
            {
              "id": 123,
              "columnPosition": 123,
              "columnName": "<string>"
            }
          ],
          "hasObservations": true
        },
        "items": [
          {
            "id": 123,
            "taskListTemplateVersionItem": {
              "id": 123,
              "name": "<string>",
              "orderIndex": 123,
              "parentId": 123
            },
            "isComplete": true,
            "traineeColumnPosition": 123,
            "trainerColumnPosition": 123,
            "auditHistory": [
              {
                "id": 123,
                "user": {
                  "id": 123,
                  "firstName": "<string>",
                  "lastName": "<string>",
                  "email": "<string>",
                  "notificationEmail": "<string>"
                },
                "positionType": "<string>",
                "oldPosition": 123,
                "newPosition": 123,
                "checkedAt": "2023-11-07T05:31:56Z",
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z"
              }
            ],
            "trainerId": 123
          }
        ],
        "groups": [
          {
            "id": 123,
            "taskListTemplateVersionItemGroup": {
              "id": 123,
              "name": "<string>",
              "orderIndex": 123,
              "parentId": 123
            },
            "isComplete": true
          }
        ],
        "phaseNames": [
          "<string>"
        ],
        "phaseEnrollments": [
          {
            "id": 123,
            "tenantId": 123,
            "phaseId": 123,
            "phaseName": "<string>",
            "user": {
              "email": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "loginEnabled": true,
              "notificationEmail": "<string>",
              "id": 123,
              "tenantId": 123,
              "idpSub": "<string>",
              "personnelId": "<string>",
              "roleId": 123,
              "mfaEnabled": true,
              "lastLoginAt": "2023-11-07T05:31:56Z",
              "isSupervisor": true,
              "isTemplatePublishingAllowed": true,
              "vlrIdentifier": "<string>",
              "passwordExpiresAt": "2023-11-07T05:31:56Z",
              "isPasswordExpired": true,
              "isSupportUser": true
            },
            "primaryTrainingOfficer": {
              "email": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "loginEnabled": true,
              "notificationEmail": "<string>",
              "id": 123,
              "tenantId": 123,
              "idpSub": "<string>",
              "personnelId": "<string>",
              "roleId": 123,
              "mfaEnabled": true,
              "lastLoginAt": "2023-11-07T05:31:56Z",
              "isSupervisor": true,
              "isTemplatePublishingAllowed": true,
              "vlrIdentifier": "<string>",
              "passwordExpiresAt": "2023-11-07T05:31:56Z",
              "isPasswordExpired": true,
              "isSupportUser": true
            },
            "startDate": "2023-12-25",
            "originalPlannedEndDate": "2023-12-25",
            "projectedEndDate": "2023-12-25",
            "actualEndDate": "2023-12-25",
            "status": "SCHEDULED",
            "statusReason": "<string>",
            "signoffId": 123
          }
        ],
        "primaryPhaseEnrollmentId": 123,
        "primaryPhaseName": "<string>",
        "primaryPhaseId": 123
      }
    ],
    "minTrainingHours": 123,
    "hasIncompleteTrainingReports": true,
    "hasIncompleteTaskLists": true,
    "canStartSignoff": true,
    "isProgressionDisabled": true,
    "existingInProgressEnrollmentId": 123,
    "totalTrainingHours": 123,
    "signoffCreatedAt": "2023-11-07T05:31:56Z"
  }
]

Path Parameters

userId
integer<int64>
required

Response

200 - */*

OK

id
integer<int64>
tenantId
integer<int64>
phaseId
integer<int64>
phaseName
string
user
object
primaryTrainingOfficer
object
startDate
string<date>
originalPlannedEndDate
string<date>
projectedEndDate
string<date>
actualEndDate
string<date>
status
enum<string>
Available options:
SCHEDULED,
IN_PROGRESS,
SUBMITTED,
WAITING_SIGNOFF,
COMPLETE,
CANCELLED
statusReason
string
signoffId
integer<int64>
hasSignoffFlow
boolean
taskLists
object[]
minTrainingHours
integer<int32>
hasIncompleteTrainingReports
boolean
hasIncompleteTaskLists
boolean
canStartSignoff
boolean
isProgressionDisabled
boolean
existingInProgressEnrollmentId
integer<int64>
totalTrainingHours
number<float>
signoffCreatedAt
string<date-time>