Datalumni public API documentation (1.0)

Hello and welcome to the Datalumni public API!

The Datalumni public API is organize around REST and uses HTTP response codes to indicate API Errors.
All requests and response bodies are encoded in JSON (application/json).

Datalumni public API endpoint is the following:

/api/public/v1/

Append this endpoint to your platform URL, depending on its configuration :

• Using a subdomain of datalumni.com: https://my-school.datalumni.com/api/public/v1/
• Using a custom domain : https://www.my-domain.com/api/public/v1/

Datalumni public API uses Bearer Authentication over HTTPS protocol.

The client must send this token in the Authorization header on every requests.

Authorization: Bearer <your-token-here>

Before you can make requests to the API, you must have generated an API token from your platform.

IMPORTANT: We only support only on API token per platform, for the time being.

Generate your API token

• In the School Settings, click on the API tab.
• If no token exists, click on the "Add an API token" button.

Select API Token owner

• Select the administrator to whom the token will be assigned.
• NB: An API token is necessarily owned by an administrator. The owner of the token can be changed at any time.

Copy API token

• A button lets you quickly copy your newly created API token.

Campus is a resource representing a campus. This resource is then used on UserRoles.

In order to be used, Campuses require School.has_campus = True. (Also see School API)

Degree is a resource representing a Degree / a training course form the School. This resource is then used on UserRoles.

Addtional fields section and subsection allow Degrees to be grouped together and will be represented as a tree data structure on your platform.

Degree is always required for Student (3) and Alumni (4). More info on UserRole API.

Lists are all the predefined options used in dropdown field on various forms throughout the platform.

Lists are usually available in French (fr) or English (en).

List scopes

• BusinessSector: Represents a business sector. Used on User's WorkExperience.
• ContractType: Represents a type of work contract. Used on User's WorkExperience.
• DegreeType: Represents a type of degree. Used on User's WorkExperience.
• Salary: Represents a salary range. Used on User's WorkExperience.
• WorkExpOpportunity: Represents the way in which the work opportunity was obtained. Used on User's WorkExperience.

Profile API refers to items (Educations, Work Experiences, Hobbies) that are listed in User profile:

• Education: represents a diploma-awarding academic course
• WorkExperience: represents a work experience
• Hobby: represents a hobby

Profile items (and their IDs) are listed on User data when searching through the User Directory endpoint.

Important: Some Education resources are automatically created with UserRole (Student / Alumni, see UserRole API). In this case, the Education resource is flagged as immutable and cannot be altered.

NB: There is no create (POST) API endpoint for Profile resources. You can only perform moderation actions on User profiles.

School API gives you access to your platform's settings.

User API allow you to manage any active / inactive Users of your platform.

This endpoint also allows you to perform User import.

UserRole is the resource that links a User to a School with a given role. Possible roles are:

• 2 SchoolAdmin: User who manage and animate the alumni platform.
• 3 Student: User that currently study in your School.
• 4 Alumni: User that studied in your School in the past.
• 5 Teacher: User that teaches in your School.
• 6 Staff: User that is part of your School staff.
• 7 External: User with access to your platform, but that are not directly related to your School.
• 8 Prospect: Prospective student that should join your School shortly.

NB: Your platform may not strictly follow the above definitions. Please confirm your platform's roles with your account manager.

Important, roles Student (3) and Alumni (4) have specific rules:

• Always require degree and graduation_year fields.
• Require campus field if `School.has_campus = true.
• A Student / Alumni UserRole is always linked to an immutable Education automatically created on User profile.

Statuses:

• Inactive: A UserRole is considered inactive when activation_date = null.
• Active: A UserRole is considered active when activation_date != null.
  A User always need at least one active UserRole in order to log in to your platform.
• Refused: A UserRole is considered as refused when deactivation_date != null. This usually represent User that did not pass the account validation.