Exemplar Systems

Batch Controller

post
/api/v1/batch/users importUsers
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- file ^*required
  
  file
  (formData)
- file
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK

Me Controller

get

/api/v1/users/me get

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "avatar_url": "string",
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "organisation_id": "string",
  "role": "string",
  "total_card_hours": 0,
  "usi": "string"
}

put

/api/v1/users/me update

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
userUpdate ^*required
(body)

userUpdate

Example Value | Model

{
  "first_name": "string",
  "last_name": "string",
  "usi": "string"
}

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "avatar_url": "string",
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "organisation_id": "string",
  "role": "string",
  "total_card_hours": 0,
  "usi": "string"
}

put
/api/v1/users/me/avatar uploadAvatar
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- file ^*required
  
  file
  (formData)
- file
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "url": "string"
}
```
get
/api/v1/users/me/cards/submissions getCardSubmission
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "daily_activity": {
    "additionalProp1": 0,
    "additionalProp2": 0,
    "additionalProp3": 0
  }
}
```

get

/api/v1/users/me/qualifications getUserQualifications

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "qualifications": [
    {
      "benchmark_progress": {
        "expected_progress_percent": 0,
        "work_areas": [
          {
            "benchmark_progress": [
              {
                "apprentice_benchmark_progress_percent": 0,
                "benchmark": 0,
                "expected_hours": 0,
                "expected_progress_percent": 0,
                "points_required": 0,
                "total_card_hours": 0
              }
            ],
            "core_work_area": true,
            "percentage_achieved": 0,
            "points": 0,
            "points_required": 0,
            "work_area": "string"
          }
        ]
      },
      "demonstration": [
        {
          "elements_not_satisfied": [
            {
              "element": "string",
              "element_met_card": {
                "card_id": "string"
              },
              "element_met_cards": [
                {
                  "card_id": "string"
                }
              ],
              "element_work_areas": [
                {
                  "work_area": "string"
                }
              ],
              "equipment_ranges": [
                {
                  "equipment_range": "string"
                }
              ],
              "minimum_occurrences": 0,
              "requirements_met": true,
              "role": "string",
              "role_specifics": [
                {
                  "role_specific": "string"
                }
              ],
              "work_area": "string"
            }
          ],
          "elements_satisfied": [
            {
              "element": "string",
              "element_met_card": {
                "card_id": "string"
              },
              "element_met_cards": [
                {
                  "card_id": "string"
                }
              ],
              "element_work_areas": [
                {
                  "work_area": "string"
                }
              ],
              "equipment_ranges": [
                {
                  "equipment_range": "string"
                }
              ],
              "minimum_occurrences": 0,
              "requirements_met": true,
              "role": "string",
              "role_specifics": [
                {
                  "role_specific": "string"
                }
              ],
              "work_area": "string"
            }
          ],
          "percentage": 0,
          "unit_code": "string"
        }
      ],
      "experience": {
        "units": [
          {
            "minimum_work_areas": 0,
            "percentage_progress": 0,
            "reason": "string",
            "requirements_met": true,
            "unit_code": "string",
            "work_areas_met": 0,
            "work_areas_met_details": [
              {
                "benchmark_progress": [
                  {
                    "apprentice_benchmark_progress_percent": 0,
                    "benchmark": 0,
                    "expected_hours": 0,
                    "expected_progress_percent": 0,
                    "points_required": 0,
                    "total_card_hours": 0
                  }
                ],
                "core_work_area": true,
                "percentage_achieved": 0,
                "points": 0,
                "points_required": 0,
                "work_area": "string"
              }
            ],
            "work_areas_not_met": 0,
            "work_areas_not_met_details": [
              {
                "benchmark_progress": [
                  {
                    "apprentice_benchmark_progress_percent": 0,
                    "benchmark": 0,
                    "expected_hours": 0,
                    "expected_progress_percent": 0,
                    "points_required": 0,
                    "total_card_hours": 0
                  }
                ],
                "core_work_area": true,
                "percentage_achieved": 0,
                "points": 0,
                "points_required": 0,
                "work_area": "string"
              }
            ]
          }
        ]
      },
      "qualification_details": {
        "code": "string",
        "description": "string",
        "id": "string"
      }
    }
  ]
}

get
/api/v1/users/me/theme getTheme
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "background_color": "string",
  "image": "string",
  "secondary_color": "string",
  "text_color": "string"
}
```

Organisation Controller

get
/api/v1/organisations list
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- type
  string
  (query)
- type
  Available values : RTO, EMPLOYER
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{}
```

post

/api/v1/organisations create

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
request ^*required
(body)

request

Example Value | Model

{
  "abn": "string",
  "email": "string",
  "name": "string",
  "phone": "string",
  "state": "string",
  "theme": {
    "background_color": "string",
    "image": "string",
    "secondary_color": "string",
    "text_color": "string"
  },
  "type": "RTO"
}

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "abn": "string",
  "email": "string",
  "id": "string",
  "name": "string",
  "phone": "string",
  "state": "string",
  "theme": {
    "background_color": "string",
    "image": "string",
    "secondary_color": "string",
    "text_color": "string"
  },
  "type": "RTO"
}

get
/api/v1/organisations/{id}/theme getTheme
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id ^*required
  string
  (path)
- id
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "background_color": "string",
  "image": "string",
  "secondary_color": "string",
  "text_color": "string"
}
```

get

/api/v1/organisations/{orgId}/qualifications/calculations getOrganisationQualificationsCalculations

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
orgld^*requiredstring
(path)
orgld

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "qualifications": [
    {
      "qualification_id": "string",
      "users": [
        {
          "avatar_url": "string",
          "calculation": {
            "benchmark_progress": {
              "expected_progress_percent": 0,
              "work_areas": [
                {
                  "benchmark_progress": [
                    {
                      "apprentice_benchmark_progress_percent": 0,
                      "benchmark": 0,
                      "expected_hours": 0,
                      "expected_progress_percent": 0,
                      "points_required": 0,
                      "total_card_hours": 0
                    }
                  ],
                  "core_work_area": true,
                  "percentage_achieved": 0,
                  "points": 0,
                  "points_required": 0,
                  "work_area": "string"
                }
              ]
            },
            "card_approved_hours": {
              "total_card_hours": 0
            },
            "card_summary": {
              "card_status_counts": [
                {
                  "count": 0,
                  "status": "ACTIVE"
                }
              ],
              "card_submission": {
                "daily_activity": {
                  "additionalProp1": 0,
                  "additionalProp2": 0,
                  "additionalProp3": 0
                }
              },
              "last_card_timestamp": "2020-07-31T16:10:32.886Z"
            },
            "demonstration_progression": {
              "unit_demonstration_statuses": [
                {
                  "elements_status": [
                    {
                      "element": "string",
                      "element_met_card": {
                        "card_id": "string"
                      },
                      "element_met_cards": [
                        {
                          "card_id": "string"
                        }
                      ],
                      "element_work_areas": [
                        {
                          "work_area": "string"
                        }
                      ],
                      "equipment_ranges": [
                        {
                          "equipment_range": "string"
                        }
                      ],
                      "minimum_occurrences": 0,
                      "requirements_met": true,
                      "role": "string",
                      "role_specifics": [
                        {
                          "role_specific": "string"
                        }
                      ],
                      "work_area": "string"
                    }
                  ],
                  "minimum_occurrences": 0,
                  "unit_code": "string"
                }
              ],
              "update_time": "2020-07-31T16:10:32.886Z"
            },
            "minimum_experience_progression": {
              "units": [
                {
                  "minimum_work_areas": 0,
                  "percentage_progress": 0,
                  "reason": "string",
                  "requirements_met": true,
                  "unit_code": "string",
                  "work_areas_met": 0,
                  "work_areas_met_details": [
                    {
                      "benchmark_progress": [
                        {
                          "apprentice_benchmark_progress_percent": 0,
                          "benchmark": 0,
                          "expected_hours": 0,
                          "expected_progress_percent": 0,
                          "points_required": 0,
                          "total_card_hours": 0
                        }
                      ],
                      "core_work_area": true,
                      "percentage_achieved": 0,
                      "points": 0,
                      "points_required": 0,
                      "work_area": "string"
                    }
                  ],
                  "work_areas_not_met": 0,
                  "work_areas_not_met_details": [
                    {
                      "benchmark_progress": [
                        {
                          "apprentice_benchmark_progress_percent": 0,
                          "benchmark": 0,
                          "expected_hours": 0,
                          "expected_progress_percent": 0,
                          "points_required": 0,
                          "total_card_hours": 0
                        }
                      ],
                      "core_work_area": true,
                      "percentage_achieved": 0,
                      "points": 0,
                      "points_required": 0,
                      "work_area": "string"
                    }
                  ]
                }
              ]
            },
            "user_experience_progression": {
              "results": [
                {
                  "benchmark_progress": [
                    {
                      "apprentice_benchmark_progress_percent": 0,
                      "benchmark": 0,
                      "expected_hours": 0,
                      "expected_progress_percent": 0,
                      "points_required": 0,
                      "total_card_hours": 0
                    }
                  ],
                  "core_work_area": true,
                  "percentage_achieved": 0,
                  "points": 0,
                  "points_required": 0,
                  "work_area": "string"
                }
              ]
            }
          },
          "card_summary": {
            "card_status_counts": [
              {
                "count": 0,
                "status": "ACTIVE"
              }
            ],
            "card_submission": {
              "daily_activity": {
                "additionalProp1": 0,
                "additionalProp2": 0,
                "additionalProp3": 0
              }
            },
            "last_card_timestamp": "2020-07-31T16:10:32.886Z"
          },
          "creation_time": "2020-07-31T16:10:32.886Z",
          "email": "string",
          "first_name": "string",
          "id": "string",
          "last_name": "string",
          "role": "SUPER_ADMIN",
          "total_card_hours": 0,
          "usi": "string"
        }
      ]
    }
  ]
}

Organisation User Controller

get

/api/v1/organisations/{orgId}/students getStudents

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
orgld^*requiredstring
(path)
orgld

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "supervisors": [
    {
      "card_summary": {
        "card_status_counts": [
          {
            "count": 0,
            "status": "ACTIVE"
          }
        ],
        "card_submission": {
          "daily_activity": {
            "additionalProp1": 0,
            "additionalProp2": 0,
            "additionalProp3": 0
          }
        },
        "last_card_timestamp": "2020-07-31T16:17:07.649Z"
      },
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "role": "SUPER_ADMIN"
    }
  ]
}

get

/api/v1/organisations/{orgId}/supervisors getSupervisors

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
orgld^*requiredstring
(path)
orgld

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "supervisors": [
    {
      "card_summary": {
        "card_status_counts": [
          {
            "count": 0,
            "status": "ACTIVE"
          }
        ],
        "card_submission": {
          "daily_activity": {
            "additionalProp1": 0,
            "additionalProp2": 0,
            "additionalProp3": 0
          }
        },
        "last_card_timestamp": "2020-07-31T16:19:18.672Z"
      },
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "role": "SUPER_ADMIN"
    }
  ]
}

post
/api/v1/organisations/{orgId}/users createTeacher
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- orgld^*required
  string
  (path)
- orgld
- request ^*required
  (body)
- request
  
  Example Value | Model
```
{
  "avatar_url": "string",
  "date_of_birth": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "organisation_id": "string",
  "phone": "string",
  "role": "SUPER_ADMIN",
  "trade_licence_number": "string",
  "usi": "string"
}
```
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
delete
/api/v1/organisations/{orgId}/users/{userId} removeOrganisationUsers
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- orgld^*required
  string
  (path)
- orgld
- userId ^*required
  string
  (path)
- userId
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content

get

/api/v1/organisations/{orgId}/users/cards getCards

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
orgld^*required
string
(path)
orgld
status
array[string]
(query)
status

Available values : ACTIVE, DELETED, PENDING, APPROVED, REJECTED, DRAFT, SUBMITTED

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

[
  {
    "card_id": "string",
    "end_time": "2020-07-31T16:33:25.217Z",
    "start_time": "2020-07-31T16:33:25.217Z",
    "status": "ACTIVE",
    "user_id": "string",
    "version": 0,
    "work_areas": [
      {
        "activities": [
          {
            "activity": "string"
          }
        ],
        "equipment_ranges": [
          {
            "equipment_range": "string"
          }
        ],
        "minutes_worked": 0,
        "supervision_level": "string",
        "work_area": "string"
      }
    ]
  }
]

Qualification Controller

get
/api/v1/qualifications list
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "qualifications": [
    {
      "code": "string",
      "description": "string",
      "id": "string"
    }
  ]
}
```

User Card Controller

get

/api/v1/users/{id}/cards getCard

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
endTimeTo
string($date-time)
(query)
endTimeTo
id^*required
string
(path)
id
startTimeFrom
string($date-time)
(query)
startTimeFrom
status
array[string]
(query)
status

Available values : ACTIVE, DELETED, PENDING, APPROVED, REJECTED, DRAFT, SUBMITTED

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

[
  {
    "card_id": "string",
    "end_time": "2020-07-31T17:36:54.654Z",
    "start_time": "2020-07-31T17:36:54.654Z",
    "status": "ACTIVE",
    "user_id": "string",
    "version": 0,
    "work_areas": [
      {
        "activities": [
          {
            "activity": "string"
          }
        ],
        "equipment_ranges": [
          {
            "equipment_range": "string"
          }
        ],
        "minutes_worked": 0,
        "supervision_level": "string",
        "work_area": "string"
      }
    ]
  }
]

post

/api/v1/users/{id}/cards addCard

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
id ^*requiredfile
(formData)
id
request ^*required
(body)

request

Example Value | Model

{
  "end_time": "2020-07-31T17:42:59.075Z",
  "start_time": "2020-07-31T17:42:59.075Z",
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "card_id": "string",
  "end_time": "2020-07-31T17:42:59.090Z",
  "start_time": "2020-07-31T17:42:59.090Z",
  "status": "ACTIVE",
  "user_id": "string",
  "version": 0,
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

delete
/api/v1/users/{userId}/cards deleteCards
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- request ^*required
  (body)
- request
  
  Example Value | Model
```
{
  "card_ids": [
    "string"
  ]
}
```
- userId ^*required
  string
  (path)
- userId
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content

get

/api/v1/users/{userId}/cards/{cardId} getCard

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
cardld^*required
string
(path)
cardId
userld^*required
string
(path)
userId

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "card_id": "string",
  "end_time": "2020-07-31T17:51:09.379Z",
  "start_time": "2020-07-31T17:51:09.379Z",
  "status": "ACTIVE",
  "user_id": "string",
  "version": 0,
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

put

/api/v1/users/{userId}/cards/{cardId} updateCard

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
cardld^*required
string
(path)
cardld
request ^*required
(body)

request

Example Value | Model

{
  "end_time": "2020-07-31T17:55:42.484Z",
  "start_time": "2020-07-31T17:55:42.484Z",
  "status": "ACTIVE",
  "version": 0,
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

userld^*required
string
(path)
userId

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "card_id": "string",
  "end_time": "2020-07-31T17:55:42.503Z",
  "start_time": "2020-07-31T17:55:42.503Z",
  "status": "ACTIVE",
  "user_id": "string",
  "version": 0,
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

put

/api/v1/users/{userId}/cards/{cardId}/status updateCardStatus

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
cardld^*required
string
(path)
cardld
request ^*required
(body)

request

Example Value | Model

{
  "comment": "string",
  "status": "ACTIVE",
  "version": 0
}

userld^*required
string
(path)
userId

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "card_id": "string",
  "end_time": "2020-07-31T17:59:40.642Z",
  "start_time": "2020-07-31T17:59:40.642Z",
  "status": "ACTIVE",
  "user_id": "string",
  "version": 0,
  "work_areas": [
    {
      "activities": [
        {
          "activity": "string"
        }
      ],
      "equipment_ranges": [
        {
          "equipment_range": "string"
        }
      ],
      "minutes_worked": 0,
      "supervision_level": "string",
      "work_area": "string"
    }
  ]
}

get

/api/v1/users/{userId}/cards/work-areas getCardWorkAreas

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
userld^*required
string
(path)
userId

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "activities": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  },
  "work_areas": [
    {
      "equipment_types": [
        {
          "equipment_ranges": [
            {
              "equipment_range": "string"
            }
          ],
          "equipment_type": "string"
        }
      ],
      "work_area": "string"
    }
  ]
}

User Controller

get

/api/v1/users/{id} getUser

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
id^*required
string
(path)
id

RESPONSES

CODE
DESCRIPTION
200

OK

Example Value | Model

{
  "avatar_url": "string",
  "email": "string",
  "first_name": "string",
  "id": "string",
  "last_name": "string",
  "organisation_id": "string",
  "role": "string",
  "total_card_hours": 0,
  "usi": "string"
}

User Organisation Controller

get
/api/v1/users/{id}/organisations listOrganisations
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "user_organisations": [
    {
      "host_employer": true,
      "organisation_id": "string",
      "status": "ACTIVE"
    }
  ]
}
```
put
/api/v1/users/{id}/organisations addOrganisations
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
- request ^*required
  (body)
- request
  
  Example Value | Model
```
{
  "organisations": [
    {
      "host_employer": true,
      "organisation_id": "string"
    }
  ]
}
```
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content
delete
/api/v1/users/{id}/organisations removeOrganisations
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
- organisationList ^*required
  (body)
- organisationList
  
  Example Value | Model
```
{
  "organisation_ids": [
    "string"
  ]
}
```
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content

User Qualification Controller

put
/api/v1/users/{id}/qualifications addQualifications
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
- qualificationList ^*required
  (body)
- qualificationList
  
  Example Value | Model
```
{
  "qualification_ids": [
    "string"
  ]
}
```
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content
delete
/api/v1/users/{id}/qualifications removeQualifications
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
- qualificationList ^*required
  (body)
- qualificationList
  
  Example Value | Model
```
{
  "qualification_ids": [
    "string"
  ]
}
```
RESPONSES
- CODE
- DESCRIPTION
- 204
- No Content
get
/api/v1/users/{id}/qualifications/ids getUserQualificationIds
PARAMETERS
- NAME
- DESCRIPTION
- Authorization
  string
  (header)
- Access Bearer Token
  Default value : Bearer token_value
- id^*required
  string
  (path)
- id
RESPONSES
- CODE
- DESCRIPTION
- 200
- OK
  
  Example Value | Model
```
{
  "qualification_ids": [
    {
      "qualification_id": "string"
    }
  ]
}
```

get

/api/v1/users/{userId}/qualifications/{qualificationId} getUserQualification

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
qualificationId ^*required
string
(path)
qualificationId
userld^*required
string
(path)
userId

RESPONSES

CODE
DESCRIPTION
20

OK

Example Value | Model

{
  "calculation": {
    "benchmark_progress": {
      "expected_progress_percent": 0,
      "work_areas": [
        {
          "benchmark_progress": [
            {
              "apprentice_benchmark_progress_percent": 0,
              "benchmark": 0,
              "expected_hours": 0,
              "expected_progress_percent": 0,
              "points_required": 0,
              "total_card_hours": 0
            }
          ],
          "core_work_area": true,
          "percentage_achieved": 0,
          "points": 0,
          "points_required": 0,
          "work_area": "string"
        }
      ]
    },
    "card_approved_hours": {
      "total_card_hours": 0
    },
    "card_summary": {
      "card_status_counts": [
        {
          "count": 0,
          "status": "ACTIVE"
        }
      ],
      "card_submission": {
        "daily_activity": {
          "additionalProp1": 0,
          "additionalProp2": 0,
          "additionalProp3": 0
        }
      },
      "last_card_timestamp": "2020-07-31T18:30:10.287Z"
    },
    "demonstration_progression": {
      "unit_demonstration_statuses": [
        {
          "elements_status": [
            {
              "element": "string",
              "element_met_card": {
                "card_id": "string"
              },
              "element_met_cards": [
                {
                  "card_id": "string"
                }
              ],
              "element_work_areas": [
                {
                  "work_area": "string"
                }
              ],
              "equipment_ranges": [
                {
                  "equipment_range": "string"
                }
              ],
              "minimum_occurrences": 0,
              "requirements_met": true,
              "role": "string",
              "role_specifics": [
                {
                  "role_specific": "string"
                }
              ],
              "work_area": "string"
            }
          ],
          "minimum_occurrences": 0,
          "unit_code": "string"
        }
      ],
      "update_time": "2020-07-31T18:30:10.287Z"
    },
    "minimum_experience_progression": {
      "units": [
        {
          "minimum_work_areas": 0,
          "percentage_progress": 0,
          "reason": "string",
          "requirements_met": true,
          "unit_code": "string",
          "work_areas_met": 0,
          "work_areas_met_details": [
            {
              "benchmark_progress": [
                {
                  "apprentice_benchmark_progress_percent": 0,
                  "benchmark": 0,
                  "expected_hours": 0,
                  "expected_progress_percent": 0,
                  "points_required": 0,
                  "total_card_hours": 0
                }
              ],
              "core_work_area": true,
              "percentage_achieved": 0,
              "points": 0,
              "points_required": 0,
              "work_area": "string"
            }
          ],
          "work_areas_not_met": 0,
          "work_areas_not_met_details": [
            {
              "benchmark_progress": [
                {
                  "apprentice_benchmark_progress_percent": 0,
                  "benchmark": 0,
                  "expected_hours": 0,
                  "expected_progress_percent": 0,
                  "points_required": 0,
                  "total_card_hours": 0
                }
              ],
              "core_work_area": true,
              "percentage_achieved": 0,
              "points": 0,
              "points_required": 0,
              "work_area": "string"
            }
          ]
        }
      ]
    },
    "user_experience_progression": {
      "results": [
        {
          "benchmark_progress": [
            {
              "apprentice_benchmark_progress_percent": 0,
              "benchmark": 0,
              "expected_hours": 0,
              "expected_progress_percent": 0,
              "points_required": 0,
              "total_card_hours": 0
            }
          ],
          "core_work_area": true,
          "percentage_achieved": 0,
          "points": 0,
          "points_required": 0,
          "work_area": "string"
        }
      ]
    }
  },
  "qualification_id": "string",
  "user_id": "string"
}

User Registration Controller

post

/api/v1/users/registration register

PARAMETERS

NAME
DESCRIPTION
Authorization
string
(header)
Access Bearer Token
Default value : Bearer token_value
request ^*required
(body)

request

Example Value | Model

{
  "avatar_url": "string",
  "date_of_birth": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "organisation_id": "string",
  "phone": "string",
  "role": "SUPER_ADMIN",
  "trade_licence_number": "string",
  "usi": "string"
}

RESPONSES

CODE
DESCRIPTION
204
No Content

APIS

eProfiling REST API

EPROFILING REST API 1.0.0

Batch Controller

/api/v1/batch/users importUsers

PARAMETERS

RESPONSES

Me Controller

/api/v1/users/me get

PARAMETERS

RESPONSES

/api/v1/users/me update

PARAMETERS

RESPONSES

/api/v1/users/me/avatar uploadAvatar

PARAMETERS

RESPONSES

/api/v1/users/me/cards/submissions getCardSubmission

PARAMETERS

RESPONSES

/api/v1/users/me/qualifications getUserQualifications

PARAMETERS

RESPONSES

/api/v1/users/me/theme getTheme

PARAMETERS

RESPONSES

Organisation Controller

/api/v1/organisations list

PARAMETERS

RESPONSES

/api/v1/organisations create

PARAMETERS

RESPONSES

/api/v1/organisations/{id}/theme getTheme

PARAMETERS

RESPONSES

/api/v1/organisations/{orgId}/qualifications/calculations getOrganisationQualificationsCalculations

PARAMETERS

RESPONSES

Organisation User Controller

/api/v1/organisations/{orgId}/students getStudents

PARAMETERS

RESPONSES

/api/v1/organisations/{orgId}/supervisors getSupervisors

PARAMETERS

RESPONSES

/api/v1/organisations/{orgId}/users createTeacher

PARAMETERS

RESPONSES

/api/v1/organisations/{orgId}/users/{userId} removeOrganisationUsers

PARAMETERS

RESPONSES

/api/v1/organisations/{orgId}/users/cards getCards

PARAMETERS

RESPONSES

Qualification Controller

/api/v1/qualifications list

PARAMETERS

RESPONSES

User Card Controller

/api/v1/users/{id}/cards getCard

PARAMETERS

RESPONSES

/api/v1/users/{id}/cards addCard

PARAMETERS

RESPONSES

/api/v1/users/{userId}/cards deleteCards

PARAMETERS

RESPONSES

/api/v1/users/{userId}/cards/{cardId} getCard

PARAMETERS

RESPONSES

/api/v1/users/{userId}/cards/{cardId} updateCard

PARAMETERS

RESPONSES

/api/v1/users/{userId}/cards/{cardId}/status updateCardStatus

PARAMETERS

RESPONSES

/api/v1/users/{userId}/cards/work-areas getCardWorkAreas

PARAMETERS