Methods

YW
Last updated 6 days ago

Https methods

Overview

base_url=https://api.labii.com/v1/

get
Organization List

/organizations/organization/list/{level}/{sid}/{serializer}/
Get a list of organizations
Request
Response
Path Parameters
level
required
string
organization or user
sid
required
string
serializer
required
string
Headers
token
required
string
200: OK
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"days_available": 182,
"add_permission": false,
"change_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"username": "xxx",
"description": "xxx",
"logo_icon": "xxx",
"logo_wordmark": "xxx",
"is_academic": false,
"is_subscription": true,
"available_till": "2019-01-01",
"payment": {
"payment_option": "Subscription",
"seats": 5,
"available_till": "2019-01-01",
"days_available": 180,
"is_academic": "False",
"credits": "$499.25"
},
"table_set": [
{
"sid": "xxx",
"icon": "assignment",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
"unique_code": "EP",
"table_type": "Document",
"order": 1
},
...
],
"project_set": [
{
"name": "xxx",
"sid": "xxx"
},
...
],
"widget_set": [
{
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text",
"subscription_price": "Free",
"PPU_price": "Free",
"notes": "Add Text with WYSIWYG Text Editor",
"component___status___WidgetActive": true,
"description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
"instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": true,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:25:22.214763Z",
"date_created": "2018-01-03T05:31:33.477489Z"
},
...
],
},
...
]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable

post
Organization List

/organizations/organization/list/{level}/{sid}/{serializer}/
Add a new organization.
Request
Response
Path Parameters
level
required
string
user
sid
required
string
serializer
required
string
Headers
token
required
string
Form Data Parameters
name
required
string
username
required
string
Username of organization.
description
optional
string
seats
optional
string
201: Created
{
"sid": "xxx",
"name": "xxx",
"username": "xxx",
"description": "xxx",
"logo_icon": "xxx",
"logo_wordmark": "xxx",
"is_academic": false,
"is_subscription": true,
"available_till": "2019-01-01",
"payment": {
"payment_option": "Subscription",
"seats": 5,
"available_till": "2019-01-01",
"days_available": 180,
"is_academic": "False",
"credits": "$499.25"
},
"table_set": [
{
"sid": "xxx",
"icon": "assignment",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
"unique_code": "EP",
"table_type": "Document",
"order": 1
},
...
],
"project_set": [
{
"name": "xxx",
"sid": "xxx"
},
...
],
"widget_set": [
{
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text",
"subscription_price": "Free",
"PPU_price": "Free",
"notes": "Add Text with WYSIWYG Text Editor",
"component___status___WidgetActive": true,
"description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
"instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": true,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:25:22.214763Z",
"date_created": "2018-01-03T05:31:33.477489Z"
},
...
],
}
401: Unauthorized
Authentication credentials were not provided.
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong id: xxx. The sid does not match to user! - The sid does not match to token information
Wrong level: xxx. Acceptable levels is user. - Wrong level provided

get
Organization Detail

/organization/detail/{sid}/
Get the organization object
Request
Response
Path Parameters
sid
required
string
organization sid
Headers
token
required
string
200: OK
{
"sid": "xxx",
"name": "xxx",
"username": "xxx",
"description": "xxx",
"logo_icon": "xxx",
"logo_wordmark": "xxx",
"is_academic": false,
"is_subscription": true,
"available_till": "2019-01-01",
"payment": {
"payment_option": "Subscription",
"seats": 5,
"available_till": "2019-01-01",
"days_available": 180,
"is_academic": "False",
"credits": "$499.25"
},
"table_set": [
{
"sid": "xxx",
"icon": "assignment",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
"unique_code": "EP",
"table_type": "Document",
"order": 1
},
...
],
"project_set": [
{
"name": "xxx",
"sid": "xxx"
},
...
],
"widget_set": [
{
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text",
"subscription_price": "Free",
"PPU_price": "Free",
"notes": "Add Text with WYSIWYG Text Editor",
"component___status___WidgetActive": true,
"description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
"instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": true,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:25:22.214763Z",
"date_created": "2018-01-03T05:31:33.477489Z"
},
...
],
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct

patch
Organization Detail

/organization/detail/{sid}/
Partial update the organization information
Request
Response
Path Parameters
sid
required
string
organization sid
Headers
token
required
string
Form Data Parameters
name
optional
string
description
optional
string
logo_icon
optional
string
Icon logo picture data
logo_wordmark
optional
string
Wordmark logo picture data
200: OK
{
"sid": "xxx",
"name": "xxx",
"username": "xxx",
"description": "xxx",
"logo_icon": "xxx",
"logo_wordmark": "xxx",
"is_academic": false,
"is_subscription": true,
"available_till": "2019-01-01",
"payment": {
"payment_option": "Subscription",
"seats": 5,
"available_till": "2019-01-01",
"days_available": 180,
"is_academic": "False",
"credits": "$499.25"
},
"table_set": [
{
"sid": "xxx",
"icon": "assignment",
"name_singular": "experiment",
"name_plural": "experiments",
"name_system": null,
"description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
"unique_code": "EP",
"table_type": "Document",
"order": 1
},
...
],
"project_set": [
{
"name": "xxx",
"sid": "xxx"
},
...
],
"widget_set": [
{
"sid": "xxx",
"icon": "format_color_text",
"name": "Rich Text",
"subscription_price": "Free",
"PPU_price": "Free",
"notes": "Add Text with WYSIWYG Text Editor",
"component___status___WidgetActive": true,
"description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
"instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": true,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:25:22.214763Z",
"date_created": "2018-01-03T05:31:33.477489Z"
},
...
],
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct

get
OrganizationMember List

/organizations/organizationmember/list/{level}/{sid}/{serializer}/
Return the members of the organization
Request
Response
Path Parameters
level
required
string
organization
sid
required
string
serializer
required
string
Headers
token
required
string
200: OK
{
"page_size": 10,
"page_number": 1,
"page_count": 1,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"title": "xxx",
"is_administrator": true,
"is_archived": false,
"date_start": "2018-01-01",
"date_end": null,
"change_permission": true
},
...
]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong level: xxx. Acceptable levels is organization. - Wrong level provided

post
OrganizationMember List

/organizations/organizationmember/list/{level}/{sid}/{serializer}/
Create one or more new OrganizationMember objects.
Request
Response
Path Parameters
level
required
string
organization
sid
required
string
serializer
required
string
Headers
token
required
string
Form Data Parameters
email
required
string
first_name
required
string
last_name
required
string
title
required
string
date_start
optional
string
date_end
optional
string
is_administrator
optional
string
is_archived
optional
string
201: Created
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"title": "xxx",
"is_administrator": true,
"is_archived": false,
"date_start": "2018-01-01",
"date_end": null,
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong level: xxx. Acceptable levels is organization. - Wrong level provided
The fields organization, user must make a unique set. - Duplicated email
Your organization do not have enough seats to add new members. Contact sales@labii.com to increase seats.
Wrong email: xxx. Emails from academic or non-profile companies only. - For academic organization only
Error: The user (xxx) already exists! - Duplicated user

get
OrganizationMember Detail

/organizations/organizationmember/detail/{sid}/
Get the detail of a OrganizationMember object.
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "xxx",
"date_start": "2018-01-01",
"date_end": null,
"is_administrator": true,
"is_archived": false,
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct

patch
OrganizationMember Detail

/organizations/organizationmember/detail/{sid}/
Update the data of a OrganizationMember object.
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
Form Data Parameters
title
optional
string
date_start
optional
string
date_end
optional
string
is_administrator
optional
boolean
is_archived
optional
boolean
200: OK
{
"sid": "xxx",
"name": "xxx",
"email": "xxx@labii.com",
"first_name": "xxx",
"last_name": "xxx",
"title": "xxx",
"date_start": "2018-01-01",
"date_end": null,
"is_administrator": true,
"is_archived": false,
"change_permission": true
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - The provided sid is not correct