--- title: "API: getLearnerCredentialReport" slug: "api-getlearnercredentialreport" updated: 2023-07-24T17:14:23Z published: 2023-07-24T17:14:23Z canonical: "support.smarteru.com/api-getlearnercredentialreport" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.smarteru.com/llms.txt > Use this file to discover all available pages before exploring further. # API: getLearnerCredentialReport - SmarterU requires all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.). - If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English. - Tags are required unless specified. ## Description The getLearnerCredentialReport runs a [Learning Plan Report](/v1/docs/learning-plan-report) for [actions](/v1/docs/actions). ## Who Has Access The following users have access to the getLearnerCredentialReport method: - Users with the [Group Manager](/v1/docs/group-permission-group-manager-gm), or [View Learner Reports](/v1/docs/group-permission-view-learner-results-vlr) group permission. - Users with the [Global Reporting](/v1/docs/account-permission-global-reporting) account permission. - [Supervisors](/v1/docs/adding-and-removing-supervisors), if the [account's **Supervisor Access** setting's](/v1/docs/supervisor-access)*Report on Supervisee*s option is checked. - [Administrators and owners](https://support.smarteru.com/docs/user-profile-information#access-level). ## API Call XML Package ```markup getLearnerCredentialReport - OR - - AND/OR - - OR - - OR - - AND/OR - ``` ## Report Tag Group The Report tag group is a container for how the response is returned and report filters. ```markup - OR - - AND/OR - - OR - - OR - - AND/OR - ``` The Report tag may contain the following. ### Type The type of report to run. Acceptable values are: - *DetailedList* - Returns the users who are assigned the action. - *Summary* - Returns a count of users who are assigned the action by status. This is the default if the Type is not specified. ### Page A container for the page number to return and the size of the response. The Page tag may contain the following. | Tag | Description | | --- | --- | | **Num** | The page number to return. The default is *1*. | | **Size** | The maximum number of records to return. If the Size tag is not provided, up to 50 results are returned by default. The maximum allowed value is 1000. | ### SortBy (optional) The SortBy tag group is a container for how the response should be ordered. Refer to [SortBy Tag Group](/v1/docs/api-getlearnercredentialreport#sortby-tag-group-optional). ### Filters The Filters tag group is a container for the report filters. Refer to [Filters Tag Group](/v1/docs/api-getlearnercredentialreport#filters-tag-group). ## SortBy Tag Group (optional) The SortBy tag group is a container for how the response should be ordered. ```markup ``` The acceptable values will depend on the [Type](/v1/docs/api-getlearnercredentialreport#type) specified. | Type | Acceptable SortBy Values | | --- | --- | | **DetailedList** | - AcceptedDate - ActionName - CredentialName - EmployeeID - ExpirationDate - LearnerName - Status - WarningDate | | **Summary** | - AcceptedCount - PendingCount - ReviewCount - CredentialName | Each sort by column is contained within less than and greater than ("<" and ">") characters. In the following example, the response will be sorted by the action's status and learner's name. ```markup ``` ## Filters Tag Group The Filters tag group is a container for the report filters. ```markup - OR - - AND/OR - - OR - - OR - - AND/OR - ``` The Filters tag may contain the following. ### Status (optional) The action status to include in the response. Acceptable values are *Pending*, *Review*, and *Accepted*. ### AcceptedDate (optional) A container for filtering actions by their accepted date. ```markup ``` The date range is contained in an AcceptedDate tag and contains the following. | Tag | Description | | --- | --- | | **AcceptedDateFrom** | The first date to include in the action's accepted date range filter. | | **AcceptedDateTo** | The last date to include in the action's accepted date range filter. | - Dates should be in dd-MMM-yyyy date format. - Only one date range may be specified for the AcceptedDate tag. ### WarningDates (optional) A container for filtering actions by their warning date. ```markup ``` The date range is contained in a WarningDate tag and contains the following. | Tag | Description | | --- | --- | | **WarningDateFrom** | The first date to include in the action's warning date range filter. | | **WarningDateTo** | The last date to include in the action's warning date range filter. | - Dates should be in dd-MMM-yyyy date format. - Only one date range may be specified for the WarningDate tag. ### ExpirationDates (optional) A container for filtering actions by their expiration date. ```markup ``` The date range is contained in an ExpirationDate tag and contains the following. | Tag | Description | | --- | --- | | **ExpirationDateFrom** | The first date to include in the action's expiration date range filter. | | **ExpirationDateTo** | The last date to include in the action's expiration date range filter. | - Dates should be in dd-MMM-yyyy date format. - Only one date range may be specified for the ExpirationDate tag. ### Credentials (optional) A container for the actions to include in the response. ```markup ``` Each action is contained in a Credential tag and contains the following. | Tag | Description | | --- | --- | | **ID** | The action's system-generated identifier. | For example, the following filters for action IDs 1234 and 9876. ```markup ``` ### Users (optional) A container for filtering actions by users. ```markup - OR - - AND/OR - ``` The Users tag may contain the following. | Tag | Description | | --- | --- | | **UserStatus** | The user's status. Acceptable values are *Active, I**nactive,* or *All*. This tag is mutually exclusive with the Identifier tag. | | **Identifier** | A container for the user email addresses and/or employee IDs. This tag is mutually exclusive with the UserStatus tag. The Identifier tag may contain the following: - EmailAddresses - A container for the users' email addresses. Each email address is contained in an EmailAddress tag. - EmployeeIDs - A container for the users' employee IDs. Each employee ID is contained in an EmployeeID tag. | ### HomeGroup (optional) The user [home group](/v1/docs/home-groups) to include in the response. ### Tags2 (optional) A container for filtering actions by their tags. ```markup - OR - ``` Each tag is contained in a Tag2 tag and may contain the following | Tag | Description | | --- | --- | | **TagID** | The tag's system-generated identifier. | | **TagName** | The [tag's name](https://support.smarteru.com/docs/tag-main#name). This is mutually exclusive with the TagID tag. | | **TagValues** | The [tag values](/v1/docs/tag-pre-defined-values) for the tag specified in the TagName tag. | ### ExpirationType (optional) The [action expiration type](https://support.smarteru.com/docs/action-expiration#expiration-date-options) to include in the response. Acceptable values are: - *ByDay* - The action's expiration is calculated using a specified number of days. - *ByDate* - The action expires on a specific month and day. ### Supervisor (optional) A container for filtering actions by their supervisors to include in the response. ```markup - OR - - AND/OR - ``` The Supervisor tag may contain the following. | Tag | Description | | --- | --- | | **SupervisorStatus** | The supervisor status to include in the response. Acceptable values are *Active*, *Inactive*, or *All*. This tag is mutually exclusive with the Identifier tag. | | **Identifier** | A container for the supervisors' email addresses and/or employee IDs to include in the response. The Identifier tag may contain the following. - EmailAddresses - A container for the supervisors' email addresses to include in the response. Each email address should be enclosed within an EmailAddress tag. - EmployeeIDs - A container for the supervisors' employee IDs to include in the response. Each employee ID should be enclosed within an EmployeeID tag. | ## API Response XML Package The getLearnerCredentialReport response will depend on the [Type](/v1/docs/api-getlearnercredentialreport#type) specified in the API call XML package. ### Response for DetailedList The following is the response for the getLearnerCredentialReport API method when [Type](/v1/docs/api-getlearnercredentialreport#type) is set to *DetailedList*. ```markup ``` The CredentialReport tag is a container for the actions returned by the getLearnerCredentialReport method. Each user who is assigned an action is contained in a LearnerCredential tag that may contain the following. | Tag | Description | | --- | --- | | **ID** | The system-generated identifier for the relationship between the action and the user the action is assigned to. | | **FirstName** | The [user's given name](https://support.smarteru.com/docs/user-login-information#given-names-required). | | **LastName** | The [user's surname](https://support.smarteru.com/docs/user-login-information#surname-required). | | **Email** | The [user's email address](https://support.smarteru.com/docs/user-login-information#primary-email-required-if-employee-id-not-specified). | | **EmployeeID** | The [user's employee ID](https://support.smarteru.com/docs/user-login-information#employee-id-required-if-primary-email-not-specified). | | **CredentialName** | The [action's name](https://support.smarteru.com/docs/action-main#name). | | **Status** | The [user's status for the action](/v1/docs/action-status-summary). | | **AcceptedDate** | The date, in UTC, the action was confirmed. | | **WarningDate** | The date, in UTC, the action's status changed to *Warning*. | | **ExpirationDate** | The date, in UTC, the action expires. | | **AcceptedDateConverted** | The date, converted to the API user's timezone, the action was confirmed. | | **WarningDateConverted** | The date, converted to the API user's timezone, the action's status changed to *Warning*. | | **ExpirationDateConverted** | The date, converted to the API user's timezone, the action expires. | The response also includes a TotalRows tag which includes a count of the records in the response. ### Example API Response XML Package for DetailedList Below is an example of an API response XML package when the Type is set to *DetailedList*. ```markup Success ``` ### Response for Summary The following is the response for the getLearnerCredentialReport API method when [Type](/v1/docs/api-getlearnercredentialreport#type) is set to *Summary*. ```markup ``` The CredentialReport tag is a container for the actions returned by the getLearnerCredentialReport method. Each action is contained in a Credential tag that contains the following. | Tag | Description | | --- | --- | | **ID** | The action's system-generated identifier. | | **CredentialName** | The [action's name](https://support.smarteru.com/docs/action-main#name). | | **Accepted** | The number of users who are assigned the action and have had the action confirmed | | **Review** | The number users assigned the action who are awaiting activity from another user. | | **Pending** | The number of users assigned the action that require activity from the user. | | **Total** | The number of users who are assigned the action. | The response also includes a TotalRows tag which includes a count of the records in the response. ### Example API Response XML Package for Summary Below is an example of an API response XML package when the Type is set to *Summary*. ```markup Success ``` ## Error Codes | Error Code | Message | | --- | --- | | GLCR:01 | The report type provided is not valid. | | GLCR:02 | Page number provided is not valid. | | GLCR:03 | Page size provided is not valid. | | GLCR:04 | The page size provided exceeds limit. | | GLCR:05 | The sort by column provided is not valid. | | GLCR:06 | The sort by order provided is not valid. | | GLCR:07 | The status provided is not valid. | | GLCR:08 | The met date provided is not valid. | | GLCR:09 | The warning date provided is not valid. | | GLCR:10 | The expiration date provided is not valid. | | GLCR:11 | The expiration type provided is not valid. | | GLCR:12 | The Credential ID provided should not be blank. | | GLCR:13 | The user status provided is not valid. | | GLCR:14 | The home group ID provided should not be blank. | | GLCR:15 | The supervisor status provided is not valid. | | GLCR:16 | The credential ID provided is not valid. | | GLCR:17 | The home group ID provided is not valid. | | GLCR:18 | User filtering is not supported in summary report. | | GLCR:19 | Home group filtering is not supported in summary report. | | GLCR:20 | Supervisor filtering is not supported in summary report. | | GLCR:21 | The learner email provided should not be blank. | | GLCR:22 | The learner employee ID provided should not be blank. | | GLCR:23 | The supervisor email provided should not be blank. | | GLCR:24 | The supervisor employee ID provided should not be blank. | | GLCR:25 | The users provided should not be blank. | | GLCR:26 | The supervisors provided should not be blank. | | GLCR:27 | The user identifier provided should not be blank. | | GLCR:28 | The supervisor identifier provided should not be blank. | | GLCR:29 | Tag ID/name provided is not found. | | GLCR:30 | Tag value provided is not found. | | GLCR:31 | Tag value provided doesn't match tag ID/name. | ## Related - [Actions](/actions.md) - [API: getCredential](/api-getcredential.md) - [API: getLearnerCertificationReport](/api-getlearnercertificationreport.md) - [API: listCredentialsCounts](/api-listcredentialscounts.md) - [API: listCredentials](/api-listcredentials.md) - [Learning Plan Report](/learning-plan-report.md)