Learnifier
  1. Projects
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. Projects

Project information

GET
/orgunits/{orgid}/projects/{projectid}
Projects
Returns project information
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://learnifier.com/orgunits//projects/'
Response Response Example
200 - Example 1
{
    "adminUrl": "http://www.example.com/adminUrl/1234",
    "country": "SE",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "8c102c8e-fabd-4c8a-b245-4d2d2f77fc4b",
    "designId": 0,
    "externalId": "string",
    "id": 0,
    "locale": "en-US",
    "name": "string",
    "note": "string",
    "orgId": 0,
    "status": "ACTIVATED",
    "timezone": "Europe/Stockholm",
    "userDescription": "string",
    "userTitle": "string"
}

Request

Path Params
orgid
integer 
required
Id of the organization unit
projectid
integer 
required
Id of the project

Responses

🟢200Project information
application/json
Body
adminUrl
string <url>
optional
URL to the page where project administration can be done. Administrative access is still required when accessing the url.
Example:
http://www.example.com/adminUrl/1234
country
string <countrycode>
optional
The country code
Example:
SE
created
string <date-time>
optional
The timestamp when this project was created.
createdBy
string <uuid>
optional
The id of the user that created the project. If the creator is not known this value is null
Example:
8c102c8e-fabd-4c8a-b245-4d2d2f77fc4b
designId
integer <int64>
optional
The id of the design this project are using or null if no design is used
externalId
string 
optional
The external id (foreign key). Must not exceed 255 characters.
id
integer <int64>
optional
Unique identifier representing a specific project. Id numbers are never reused.
locale
string <locale>
optional
The primary locale for this project
Example:
en-US
name
string 
optional
The internal name of the project
note
string 
optional
The internal note field
orgId
integer <int64>
optional
The id of the organization unit this project belongs to
status
enum<string> 
optional
Project status. Can be either ACTIVATED, NEW or DISABLED
Allowed values:
ACTIVATEDNEWDISABLED
Example:
ACTIVATED
timezone
string <timezone>
optional
The main timezone for the project
Example:
Europe/Stockholm
userDescription
string 
optional
The description presented to participants. This value can be null.
userTitle
string 
optional
The title presented to participants
🔴500Unexpected error
Previous
Deletes the project
Next
Update project information
Built with