Introduction
This is a companion to the Snapper Grape API documentation. It describes the data types returned from Snapper Grape API as of version 2.4.1
JSON data types
In addition to the standard JSON data types (number, string, boolean, array, object), we define here a data type date. Date is a string representation of a datetime object, on ISO standard format: ”2014-01-20 14:10”.
Attributes and configuration of Snapper Grape
Many of these objects are subject to configuration in Snapper Grape. Super users of Snapper Grape can turn on or off attributes at will. Some attributes may also have different meanings in different installations, and will have a rather vague description. This document describes all possible attributes of the objects. What you actually see when performing an API call most likely has fewer attributes than described here.
Role
Persons in Snapper Grape have zero or more roles. These roles typically define which competences are required. Roles are of different types, and thus can mean slightly different things. The most important type is the ”position” role, which gives the person his/her authorization level in Snapper Grape, and also defines which Organisation he/she belongs to. For this reason, positions have a separate API call, but roles of type position is still included in this call.
Simple representation
Full representation
description
String
Nullable
organisation_id
Number
Nullable
ID of organisation the role is linked to for person. Can indicate that person belongs to this organisation, but may have other meanings too.
Competence
A competence in Snapper Grape, is the definition of a course, e-course, certificate or any other kind of training/skill/qualification that a person can either have or not, and that can be either required or not. This object does not take into account how it relates to the logged in (or any other)s person, only how it is defined.
Simple representation
competence_type
String
Name of the competence type.
code
String
Internal code for the competence.
Full representation
competence_id
Number
Unique ID for this competence.
competence_type
String
Name of the competence type.
code
String
Internal code for the competence.
valid_for
String
Defines for how long the competence is valid, from the time it is acquired by a person.
duration
String
Applies to competences of type ”course”. Defines how many days the course typically lasts.
short_description
String
Nullable
Short description of the competence.
description
String
Nullable
Full description of the competence.
colorcode
String
Nullable
Hex color code for the competence.
modified
Date
The last time the competence object was changed.
checked_by
String
Nullable
Applicable for competences of type ”checklist_item”. Values: ”self”/”manager”/”both”/”either”. Indicates what is requied for the checklist item to be regarded as fulfilled.
children
Array
Applicable for competences of type ”group”, ”checklist”, ”complex”, ”competence”. List of children Competence objects (simple view).
files
Array
File objects for files added to competence.
locale
String
Nullable
Locale code (”no”/”en”) representing the language of the competence.
languages_available
Array
List of all available languages for competence.