- 8 Minutes to read
-
Print
-
DarkLight
API: getLearnerCredentialReport
- 8 Minutes to read
-
Print
-
DarkLight
- Starting June 1, 2022, SmarterU will require 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 is used to run a Learning Plan Report for actions.
Who Has Access
The following users have access to the getLearnerCredentialReport method:
- Users with the Group Manager, or View Learner Reports group permission.
- Users with the Global Reporting account permission.
- Supervisors, if the account's Supervisor Access setting's Report on Supervisees option is checked.
- Administrators and owners.
API Call XML Package
<SmarterU>
<AccountAPI><![CDATA[]]></AccountAPI>
<UserAPI><![CDATA[]]></UserAPI>
<Method>getLearnerCredentialReport</Method>
<Parameters>
<Report>
<Type><![CDATA[]]></Type>
<Page>
<Num></Num>
<Size></Size>
</Page>
<SortBy></SortBy>
<Filters>
<Status></Status>
<AcceptedDates>
<AcceptedDate>
<AcceptedDateFrom><![CDATA[]]></AcceptedDateFrom>
<AcceptedDateTo><![CDATA[]]></AcceptedDateTo>
</AcceptedDate>
</AcceptedDates>
<WarningDates>
<WarningDate>
<WarningDateFrom><![CDATA[]]></WarningDateFrom>
<WarningDateTo><![CDATA[]]></WarningDateTo>
</WarningDate>
</WarningDates>
<ExpirationDates>
<ExpirationDate>
<ExpirationDateFrom><![CDATA[]]></ExpirationDateFrom>
<ExpirationDateTo><![CDATA[]]></ExpirationDateTo>
</ExpirationDate>
</ExpirationDates>
<Credentials>
<Credential>
<ID><![CDATA[]]></ID>
</Credential>
</Credentials>
<Users>
<UserStatus><![CDATA[]]></UserStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
</Users>
<HomeGroup><![CDATA[]]></HomeGroup>
<Tags2>
<Tag2>
<TagID><![CDATA[]]></TagID>
- OR -
<TagName><![CDATA[]]></TagName>
<TagValues><![CDATA[]]></TagValues>
</Tag2>
</Tags2>
<ExpirationType><![CDATA[]]></ExpirationType>
<Supervisor>
<SupervisorStatus></SupervisorStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
<Supervisor/>
</Filters>
</Report>
</Parameters>
</SmarterU>
Report Tag Group
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. This is the default if the Type is not specified.
Page
The Page tag group is a container for the page number returned by the response and the size of the response. Refer to Page Tag Group.
SortBy (optional)
The SortBy tag group is a container for the columns to use to order the response. Refer to SortBy Tag Group.
Filters
The Filters tag group is a container for the filters you want to apply. Refer to Filters Tag Group.
Page Tag Group
The Page tag group is a container for the page number returned by the response and the size of the response.
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 Tag Group (optional)
The SortBy tag group is a container for the columns to use to order the response. The acceptable values will depend on the Type specified.
Type | Acceptable SortBy Values |
---|---|
DetailedList |
|
Summary |
|
Each sort by column should be enclosed 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.
<SortBy>
<Status>
<LearnerName>
</SortBy>
Filters Tag Group
The Filters tag group is a container for the filters you want to apply.
<Filters>
<Status></Status>
<AcceptedDates>
<AcceptedDate>
<AcceptedDateFrom><![CDATA[]]></AcceptedDateFrom>
<AcceptedDateTo><![CDATA[]]></AcceptedDateTo>
</AcceptedDate>
</AcceptedDates>
<WarningDates>
<WarningDate>
<WarningDateFrom><![CDATA[]]></WarningDateFrom>
<WarningDateTo><![CDATA[]]></WarningDateTo>
</WarningDate>
</WarningDates>
<ExpirationDates>
<ExpirationDate>
<ExpirationDateFrom><![CDATA[]]></ExpirationDateFrom>
<ExpirationDateTo><![CDATA[]]></ExpirationDateTo>
</ExpirationDate>
</ExpirationDates>
<Credentials>
<Credential>
<ID><![CDATA[]]></ID>
</Credential>
</Credentials>
<Users>
<UserStatus><![CDATA[]]></UserStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
</Users>
<HomeGroup><![CDATA[]]></HomeGroup>
<Tags2>
<Tag2>
<TagID><![CDATA[]]></TagID>
- OR -
<TagName><![CDATA[]]></TagName>
<TagValues><![CDATA[]]></TagValues>
</Tag2>
</Tags2>
<ExpirationType><![CDATA[]]></ExpirationType>
<Supervisor>
<SupervisorStatus></SupervisorStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
<Supervisor/>
</Filters>
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 the accepted date range to include in the response.
<AcceptedDates>
<AcceptedDate>
<AcceptedDateFrom><![CDATA[]]></AcceptedDateFrom>
<AcceptedDateTo><![CDATA[]]></AcceptedDateTo>
</AcceptedDate>
</AcceptedDates>
An AcceptedDate tag must be added with 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 the warning date range to include in the response.
<WarningDates>
<WarningDate>
<WarningDateFrom><![CDATA[]]></WarningDateFrom>
<WarningDateTo><![CDATA[]]></WarningDateTo>
</WarningDate>
</WarningDates>
A WarningDate tag must be added with 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 the expiration date range to include in the response.
<ExpirationDates>
<ExpirationDate>
<ExpirationDateFrom><![CDATA[]]></ExpirationDateFrom>
<ExpirationDateTo><![CDATA[]]></ExpirationDateTo>
</ExpirationDate>
</ExpirationDates>
An ExpirationDate tag must be added with 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.
<Credentials>
<Credential>
<ID><![CDATA[]]></ID>
</Credential>
</Credentials>
For each action filter, a Credential tag must be added with the following.
Tag | Description |
---|---|
ID | The action's system-generated identifier. |
For example, the following filters for action IDs 1234 and 9876.
<Credentials>
<Credential>
<ID><![CDATA[1234]]></ID>
</Credential>
<Credential>
<ID><![CDATA[9876]]></ID>
</Credential>
</Credentials>
Users (optional)
A container for the users to include in the response.
<Users>
<UserStatus><![CDATA[]]></UserStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
</Users>
The User tag may contain the following.
Tag | Description |
---|---|
UserStatus | The user's status. Acceptable values are Active, Inactive, or All. This tag is mutually exclusive with the Identifier tag. |
Identifier | A container for the user email addresses and/or employee IDs. This is mutually exclusive with the UserStatus tag. The Identifier tag may contain the following.
|
HomeGroup (optional)
The user home group to include in the response.
Tags2 (optional)
A container for the tags to include in the response.
<Tags2>
<Tag2>
<TagID><![CDATA[]]></TagID>
- OR -
<TagName><![CDATA[]]></TagName>
<TagValues><![CDATA[]]></TagValues>
</Tag2>
</Tags2>
For each action tag filter, a Tag2 tag must be added with the following.
Tag | Description |
---|---|
TagID | The tag's system-generated identifier. |
TagName | The tag's name. This is mutually exclusive with the TagID tag. |
TagValues | The tag values for the tag specified in the TagName tag. |
ExpirationType (optional)
The action expiration type 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 the supervisors to include in the response.
<Supervisor>
<SupervisorStatus></SupervisorStatus>
- OR -
<Identifier>
<EmailAddresses>
<EmailAddress><![CDATA[]]></EmailAddress>
</EmailAddresses>
- AND/OR -
<EmployeeIDs>
<EmployeeID><![CDATA[]]></EmployeeID>
</EmployeeIDs>
</Identifier>
<Supervisor/>
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.
|
API Response XML Package
The getLearnerCredentialReport response will depend on the Type specified in the API call XML package.
Response for DetailedList
The following is the response for the getLearnerCredentialReport API method when Type is set to DetailedList.
<SmarterU>
<Result></Result>
<Info>
<CredentialReport>
<LearnerCredential>
<ID><![CDATA[]]></ID>
<FirstName><![CDATA[]]></FirstName>
<LastName><![CDATA[]]></LastName>
<EmployeeID><![CDATA[]]></EmployeeID>
<CredentialName><![CDATA[]]></CredentialName>
<Status><![CDATA[]]></Status>
<AcceptedDate><![CDATA[]]><AcceptedDate/>
<WarningDate><![CDATA[]]></WarningDate>
<ExpirationDate><![CDATA[]]></ExpirationDate>
<AcceptedDateConverted><![CDATA[]]></AcceptedDateConverted>
<WarningDateConverted><![CDATA[]]></WarningDateConverted>
<ExpirationDateConverted><![CDATA[]]></ExpirationDateConverted>
</LearnerCredential>
<TotalRows><![CDATA[]]></TotalRows>
</CredentialReport>
</Info>
<Errors>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Errors>
</SmarterU>
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. |
LastName | The user's surname. |
EmployeeID | The user's employee ID. |
CredentialName | The action's name. |
Status | The user's status for the action. |
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.
The Errors tag contains any error codes returned by the getLearnerCredentialReport method.
Below is an example of an API response XML package when the Type is set to DetailedList.
<SmarterU>
<Result>Success</Result>
<Info>
<CredentialReport>
<LearnerCredential>
<ID><![CDATA[392802]]></ID>
<FirstName><![CDATA[Dana]]></FirstName>
<LastName><![CDATA[Brown]]></LastName>
<EmployeeID><![CDATA[1271]]></EmployeeID>
<CredentialName><![CDATA[Physical Exam]]></CredentialName>
<Status><![CDATA[Accepted]]></Status>
<AcceptedDate><![CDATA[13-Aug-2021]]></AcceptedDate>
<WarningDate><![CDATA[14-Jul-2022]]></WarningDate>
<ExpirationDate><![CDATA[13-Aug-2022]]></ExpirationDate>
<AcceptedDateConverted><![CDATA[ 12-Aug-2021]]></AcceptedDateConverted>
<WarningDateConverted><![CDATA[ 13-Jul-2022]]></WarningDateConverted>
<ExpirationDateConverted><![CDATA[ 12-Aug-2022]]></ExpirationDateConverted>
</LearnerCredential>
<LearnerCredential>
<ID><![CDATA[41]]></ID>
<FirstName><![CDATA[Dana]]></FirstName>
<LastName><![CDATA[Brown]]></LastName>
<EmployeeID><![CDATA[1271]]></EmployeeID>
<CredentialName><![CDATA[Driver's License]]></CredentialName>
<Status><![CDATA[Accepted]]></Status>
<AcceptedDate><![CDATA[13-Aug-2021]]></AcceptedDate>
<WarningDate><![CDATA[15-May-2022]]></WarningDate>
<ExpirationDate><![CDATA[13-Aug-2022]]></ExpirationDate>
<AcceptedDateConverted><![CDATA[ 12-Aug-2021]]></AcceptedDateConverted>
<WarningDateConverted><![CDATA[ 14-May-2022]]></WarningDateConverted>
<ExpirationDateConverted><![CDATA[ 12-Aug-2022]]></ExpirationDateConverted>
</LearnerCredential>
<LearnerCredential>
<ID><![CDATA[13]]></ID>
<FirstName><![CDATA[Sara]]></FirstName>
<LastName><![CDATA[Davis]]></LastName>
<EmployeeID><![CDATA[3948]]></EmployeeID>
<CredentialName><![CDATA[Driver's License]]></CredentialName>
<Status><![CDATA[Accepted]]></Status>
<AcceptedDate><![CDATA[09-Aug-2021]]></AcceptedDate>
<WarningDate><![CDATA[11-May-2022]]></WarningDate>
<ExpirationDate><![CDATA[09-Aug-2022]]></ExpirationDate>
<AcceptedDateConverted><![CDATA[ 08-Aug-2021]]></AcceptedDateConverted>
<WarningDateConverted><![CDATA[ 10-May-2022]]></WarningDateConverted>
<ExpirationDateConverted><![CDATA[ 08-Aug-2022]]></ExpirationDateConverted>
</LearnerCredential>
<TotalRows><![CDATA[3]]></TotalRows>
</CredentialReport>
</Info>
<Errors>
</Errors>
</SmarterU>
Response for Summary
The following is the response for the getLearnerCredentialReport API method when Type is set to Summary.
<SmarterU>
<Result></Result>
<Info>
<CredentialReport>
<Credential>
<ID><![CDATA[]]></ID>
<CredentialName><![CDATA[]]></CredentialName>
<Accepted><![CDATA[]]></Accepted>
<Review><![CDATA[]]></Review>
<Pending><![CDATA[]]></Pending>
<Total><![CDATA[]]></Total>
</Credential>
</CredentialReport>
<TotalRows><![CDATA[]]></TotalRows>
</Info>
<Errors>
<ErrorID></ErrorID>
<ErrorMessage></ErrorMessage>
</Errors>
</SmarterU>
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. |
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.
The Errors tag contains any error codes returned by the getLearnerCredentialReport method.
Below is an example of an API response XML package when the Type is set to Summary.
<SmarterU>
<Result>Success</Result>
<Info>
<CredentialReport>
<Credential>
<ID><![CDATA[1003]]></ID>
<CredentialName><![CDATA[Background Check]]></CredentialName>
<Accepted><![CDATA[1]]></Accepted>
<Review><![CDATA[0]]></Review>
<Pending><![CDATA[6]]></Pending>
<Total><![CDATA[7]]></Total>
</Credential>
</CredentialReport>
<Credential>
<ID><![CDATA[1421]]></ID>
<CredentialName><![CDATA[Completed Emergency Contact Form]]></CredentialName>
<Accepted><![CDATA[6]]></Accepted>
<Review><![CDATA[0]]></Review>
<Pending><![CDATA[27]]></Pending>
<Total><![CDATA[33]]></Total>
</Credential>
<TotalRows><![CDATA[2]]></TotalRows>
</Info>
<Errors>
</Errors>
</SmarterU>
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. |