Learnifier
  1. Users
Learnifier
  • Course Designs
    • Lists all global course design templates
      GET
  • Organization Units
    • Get Organization Unit with External Id
      GET
    • Organization Units
      GET
    • Adds an Organization Unit
      POST
    • Get Organization Unit
      GET
    • Updates an Organization Unit
      PATCH
  • Users
    • Gets a participation by external id
      GET
    • Gets a user by external id
      GET
    • Lists all users
      GET
    • Adds a user
      POST
    • User information
      GET
    • Updates user information
      PATCH
    • User profile picture
      GET
    • Returns information about the projects the user is a participant in.
      GET
  • Projects
    • Gets Organization Unit by external id
      GET
    • Organization Unit Projects
      GET
    • Create project
      POST
    • Deletes the project
      DELETE
    • Project information
      GET
    • Update project information
      PATCH
    • Project participants
      GET
    • Add participant
      POST
    • Deletes a participant
      DELETE
    • Activate participant
      POST
    • Participant login link
      POST
    • Project team members
      GET
  • Global User Groups
    • List Global User Groups.
    • List of all users in group.
  • User Groups
    • List User Groups.
    • Create a User Group.
    • Get user group
    • List of all users in group.
    • Add user group member.
    • Remove user group member.
  1. Users

Gets a participation by external id

GET
/extparticipation
Users
Gets a participation by external id.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://learnifier.com/extparticipation?extid='
Response Response Example
200 - Example 1
{
    "accessLink": "http://www.example.com/accesslink/123451",
    "activated": true,
    "activitiesCompleted": 3,
    "activitiesTotal": 5,
    "errorMessage": "string",
    "expiration": "2019-08-24T14:15:22Z",
    "externalId": "string",
    "firstAccess": "2019-08-24T14:15:22Z",
    "firstActivation": "2019-08-24T14:15:22Z",
    "firstMail": "2019-08-24T14:15:22Z",
    "id": 0,
    "inError": true,
    "lastAccess": "2019-08-24T14:15:22Z",
    "lastActivation": "2019-08-24T14:15:22Z",
    "lastMail": "2019-08-24T14:15:22Z",
    "projectId": 0,
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Request

Query Params
extid
string 
required
The external id of the participation

Responses

🟢200The matching participation
application/json
Body
accessLink
string <url>
optional
A link to access this particular participation. The link requires the user to login. Users that access the platform the first time must set a password. This value is null if this participation is not activated.
Example:
http://www.example.com/accesslink/123451
activated
boolean 
optional
True if this participation has been activated and can be used
activitiesCompleted
number <int64>
optional
The number of activities completed
Example:
3
activitiesTotal
number <int64>
optional
The total number of activities
Example:
5
errorMessage
string 
optional
An optional error message that may describe why the participation is in error state.
expiration
string <date-time>
optional
The timestamp when this participation will expire. Expiration never happens if this value is null.
externalId
string 
optional
The external id (foreign key). Must not exceed 255 characters.
firstAccess
string <date-time>
optional
The timestamp when the participant accessed the project for the first time. This value can be null
firstActivation
string <date-time>
optional
The timestamp when this participation was first activated. This value can be null
firstMail
string <date-time>
optional
The timestamp when the first mail was sent to this participant. This value can be null
id
integer <int64>
optional
Unique identifier representing this participation. Id numbers are never reused
inError
boolean 
optional
True if this participation is in an error state. The user is not able to access participations that are in error state.
lastAccess
string <date-time>
optional
The timestamp when the participant accessed the project the last time. This value can be null
lastActivation
string <date-time>
optional
The timestamp when this participation was last activated. This value can be null
lastMail
string <date-time>
optional
The timestamp when the last mail was sent to this participant. This value can be null
projectId
integer <int64>
optional
The id of the project this participation belongs to
userId
string <uuid>
optional
The id of the user this participation belongs to
🟠404User not found
🔴500Unexpected error
Previous
Updates an Organization Unit
Next
Gets a user by external id
Built with