EXPORT - Get information about a user
Resource URL
URL: user/export/information
Parameters
string username | Username |
string password | Password |
int pageNumber | Page number to retrieve |
int pageSize | Maximum number of elements on each page |
Return value
The method returns information about the user
| userDetails | A list containing user details for a specific user |
| userDetails[].userId | Trainingportal id of the user. |
| userDetails[].userExternalId | External Id of the user. |
| userDetails[].firstName | First name |
| userDetails[].lastName | Last name |
| userDetails[].birhtDate | Birth date of the user, on format YYYY-MM-DD |
userDetails[].eMailAddress | E-mail address |
| userDetails[].phoneCountryCode | Country code for the user's phone number. may be prefixed with "+". Example: "+47" or "47" |
| userDetails[].phoneNumber | Phone number for the user, without country code |
| userDetails[].prefferedLanguage | ISO 639-1 (two letter abbreviation) for the user's preferred language. Currently supported languages are:
|
| userDetails[].addressLine1 | Address, line 1 |
| userDetails[].addressLine2 | Address, line 2 |
| userDetails[].zipCode | Address, zip Code |
| userDetails[].city | Address, city |
| userDetails[].country | Address, country |
| userDetails[].gender | Gender. MALE or FEMALE |
| userDetails[].portalSpecificAttributes | Portal specific attributes for the user. Each attribute will be a key/value pair with logicalId of the attribute as key. |
| userDetails[].userUsername | Username for the created user. |
| userDetails[].role | Role for the user. Empty if the user has no specific role. |
| pageNumber | Number of the current page |
| pageSize | Size of the current page |
Example request
URL | https://www.trainingportal.no/mintra/rest/user/export/information |
| POST DATA | username=username&password=secret&pageNumber=10&pageSize=20 |
{
"userDetails": [
{
"userId": 123,
"userExternalId": "abc",
"firstName": "Nameless",
"lastName": "",
.... # and so on
}
],
"pageNumber": 10,
"pageSize": 20
}
