Learnifier
  1. Organization Units
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. Organization Units

Organization Units

GET
/orgunits
Organization Units
The orgunits endpoint returns information about the available organization units (orgunits).
The response includes the display name, internal and external id and client number.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://learnifier.com/orgunits'
Response Response Example
200 - Example 1
{
    "orgUnits": [
        {
            "externalId": "string",
            "id": 0,
            "name": "string",
            "parentId": 0,
            "type": "string"
        }
    ]
}

Request

None

Responses

🟢200A response with organization units
application/json
Body
orgUnits
array[object (OrgUnit) {5}] 
optional
externalId
string 
optional
The external id (foreign key). Must not exceed 255 characters.
id
integer <int64>
required
Unique identifier representing a specific organization unit. Id numbers are never reused.
name
string 
optional
The name of the client.
parentId
integer <int64>
optional
Unique identifier of the parent or null if there is no parent.
type
string 
required
The organization unit type. The only type is client at the moment.
🔴500Unexpected error
Previous
Get Organization Unit with External Id
Next
Adds an Organization Unit
Built with