Overview
Overview of Labii API
Labii API is a REST API and it support all different calling methods.
Object has two type of url represent two different views:
List
{{base_url}}/{app}/{model}/list/{level}/{sid}/{serializer}/View
{{base_url}}/{app}/{model}/detail/{sid}/
Wheres,
base_url=https://api.labii.com/v1/, the link will change as version changes.
app, the name of application. See Link for more details.
model, the name of model. See Link for more details.
level, the scope of records to retrieve. See Levels for more details.
sid, Static and encrypted labii object id. It have to match with level. Of
level=organization, thesidhave to be thesidof aorganization.serializer, scope of fields of the return data
name, return only
sidandnamelist, return selected fields of the objects
detail, return all fields of the objects
Each API has a list list and detail view.
API | Description | List view | Detail view |
Organization | The organization object |
|
|
Organization Member | Member of the organization |
|
|
Team | Team of the organization |
|
|
Organization Widget | Installed widgets |
|
|
Statement | Monthly statement |
|
|
Backup | Backup data |
|
|
Project | The project object |
|
|
Project Member | Project member or team |
|
|
Table | The table object |
|
|
Column | The columns of a table |
|
|
Filter | The filters of a table |
|
|
Row | The rows of a table |
|
|
Cell | The cells of a row |
|
|
Section | The sections of a row |
|
|
Version | The versions of a row |
|
|
Activity | User activities |
|
|
Widget | The widget object |
|
|
Levels defines the scope of records to retrieve. It is a required parameter for list API. These levels are used at Labii:
organization: return the results within the organization level
user: return the results for a particular user
project: return the results for a project
Not all levels are available for all list API. Error of HTTP_406_NOT_ACCEPTABLE will return if a wrong level is used. The table below lists all allowed levels:
List API | level=organization | level=user | level=project |
Organization List | Yes | Yes | - |
Organization Member List | Yes | - | - |
Team List | Yes | Yes | - |
Organization Widget | Yes | - | - |
Statement List | Yes | - | - |
Backup List | Yes | - | - |
Project List | Yes | Yes | - |
Project Member List | Yes | - | Yes |
Table List | Yes | - | - |
Column List | Yes | - | - |
Filter List | Yes | Yes | - |
Row List | Yes | Yes | Yes |
Cell List | Yes | - | - |
Section List | Yes | - | - |
Version List | Yes | - | - |
Activity | Yes | Yes | - |
Widget | * | - | - |
Here are list of methods used:
GET: Fetch one or more objects
POST: Create an object
PUT: Update an object
PATCH: Partially update an object
DELETE: Remove an object
Different roles have different permissions in using the methods. There are five roles at the organization level:
Admin: The administrators
Member: The members of the organization
Alumni: The members who have left the organization
User: Other Labii users who do not belong to the organization
Anonymous: Unauthorized user
And 3 roles at the project level:
Project Admin: The administrator of a project
Project Edit: The members has
editpermission at the projectProject View: The members has
viewpermission at the project
API | GET | POST | PUT | PATCH | DELETE |
Organization List | Admin, Member | Admin | - | - | - |
Organization Detail | Admin, Member | - | - | Admin | - |
Organization Member List | Admin, Member | Admin | - | - | - |
Organization Member Detail | Admin, Member | - | - | Admin | - |
Team List | Admin, Member | Admin | - | - | - |
Team Detail | Admin, Member | - | - | Admin | Admin |
Organization Widget List | Admin, Member | Admin | - | - | Admin |
Organization Widget Detail | Admin, Member | - | - | - | Admin |
Statement List | Admin | - | - | - | - |
Statement Detail | Admin | - | - | - | - |
Backup List | Admin | Admin | - | - | - |
Backup Detail | Admin | - | - | - | - |
Project List | Admin, Project Admin, Project Edit, Project View | Admin | - | - | - |
Project Detail | Admin, Project Admin, Project Edit, Project View | - | - | Admin, Project Admin | - |
Project Member List | Admin, Project Admin, Project Edit, Project View | Admin, Project Admin | - | - | - |
Project Member Detail | Admin, Project Admin, Project Edit, Project View | - | - | Admin, Project Admin | Admin, Project Admin |
Table List | Admin, Member | Admin | - | - | - |
Table Detail | Admin, Member | - | - | Admin | - |
Column List | Admin, Member | Admin | - | - | - |
Column Detail | Admin, Member | - | - | Admin | - |
Filter List | Admin, Member | Admin, Member | - | - | - |
Filter Detail | Admin, Member | - | - | Admin, Member | Admin, Member |
Row List | Admin, Project Admin, Project Edit, Project View | Project Admin, Project Edit | - | Project Admin, Project Edit | - |
Row Detail | Admin, Project Admin, Project Edit, Project View | - | - | Project Admin, Project Edit | - |
Cell List | Admin, Project Admin, Project Edit, Project View | Project Admin, Project Edit | - | - | - |
Cell Detail | - | - | - | Project Admin, Project Edit | - |
Section List | Admin, Project Admin, Project Edit, Project View | Project Admin, Project Edit | - | - | - |
Section Detail | Admin, Project Admin, Project Edit, Project View | - | - | Project Admin, Project Edit | - |
Version List | Admin, Project Admin, Project Edit, Project View | - | - | - | - |
Version Detail | Admin, Project Admin, Project Edit, Project View | - | - | - | - |
Activity List | Admin, Member | - | - | - | - |
Activity Detail | - | - | - | - | - |
Widget List | Admin, Member | - | - | - | - |
Widget Detail | Admin, Member | - | - | - | - |
Here is a list of status code used by Labii API:
HTTP_200_OK: return when api call successful
HTTP_201_CREATED: return when a object is created
HTTP_204_NO_CONTENT: return when a object is successfully deleted
HTTP_401_UNAUTHORIZED: return when user is not authenticated
HTTP_403_FORBIDDEN: return when user do not have permission
HTTP_406_NOT_ACCEPTABLE: return when parameter is not correct
HTTP_500_INTERNAL_SERVER_ERROR: return on internal errors