NTeALan API for african language dictionaries

hello

Articles

Manage articles of all dictionaries

Create new article of a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Create an new article in the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id

Headers:

Parameter	Type	Description
Accept	mimeType	List of accepted MimeTypes
X-Access-Token	string	Authentication token

Response:

Body:

{
"article": {
"type": any
}
}

Codes:

Code	Message	Description
201	Article created	Article content is correctly created of current dictionary exists
401	Unauthorized to create Article	Only admin user with valid token can create article of the current dictionary
404	Article content not found	Article content of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

POST /articles/yb_fr_3031 HTTP/1.1 Content-Type: application/json; charset=utf-8 Accept: application/json X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Sample:

Request:

POST /dictionaries/articles/dl_fr_2018 HTTP/1.1 Content-Type: application/json; charset=utf-8 Accept: application/json X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Delete all articles of a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Delete all articles of a dictionary without its metadata

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id

Query String Parameters:

Parameter	Type	Optional	Description
article_id	integer		Article Id

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"dictionary": {
"type": any
}
}

Codes:

Code	Message	Description
200	Dictionary deleted	Dictionary with the specified id is correctly deleted
401	Unauthorized to delete dictionary	Only admin user with valid token can delete a dictionary
404	Dictionary content not found	Dictionary content does not exists or dictionary's id is invalid

Sample:

Request:

DELETE /articles/yb_fr_3031?article_id=63 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "dictionary": { "type": "my_type" } }

Sample:

Request:

DELETE /dictionaries/articles/yb_fr_3031?article_id=63 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "dictionary": { "type": "my_type" } }

Delete article of a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Delete an article content of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"article": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article deleted	Article content is correctly deleted of current dictionary exists
401	Unauthorized to delete Article	Only admin user with valid token can delete article of the current dictionary
404	Article content not found	Article content of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

DELETE /articles/yb_fr_3031/567 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Sample:

Request:

DELETE /dictionaries/articles/yb_fr_3031/567 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Search articles in dictionaries

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Search articles in all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?search={searchTerm} https://apis.ntealan.net/ntealan/dictionaries/articles?search={searchTerm}

URI Parameters:

Parameter	Type	Optional	Description
searchTerm	string		Content of article to search

Response:

Body:

{
"search": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Articles found	Articles of dictionaries exists
206	Articles not found (partial content)	Articles of dictionaries do not exist

Sample:

Request:

GET /articles?search=calcaire HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "search": [ { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?search=calcaire HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "search": [ { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" }, { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" } ] }

Search articles in dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Search articles in the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?search={searchTerm} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?search={searchTerm}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
searchTerm	string		Content of article to search

Response:

Body:

{
"search": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Articles found	Articles of current dictionary exists
206	Articles not found (partial content)	Articles of current dictionary does not exist or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031?search=mba-nnɛ HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?search=mba-nnɛ HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show Form of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article form of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?form https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?form

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"form": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article form found	Article form of current dictionary exists
206	Article form not found	Article form of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/681?form HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "form": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/681?form HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "form": { "type": "my_type" } }

Show HTML content of article in all dictionaries

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List html version of articles in all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?html&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?html&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"contents": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Article html found	HTLM version of article exists in some dictionaries
206	Article html not found	HTML version of article do not exist in all dictionaries

Sample:

Request:

GET /articles?html&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "contents": [ { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" }, { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" } ] }

Sample:

Request:

GET /dictionaries/articles?html&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show HTML content of articles for a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List html version of articles for a dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?html&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?html&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Public dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"contents": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Article html found	HTLM version of article exists in this dictionary
206	Article html not found	HTML version of article do not exist in this dictionary

Sample:

Request:

GET /articles/yb_fr_3031?html&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?html&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show XML content of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List article contents of all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?contents&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?contents&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"contents": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Article contents found	Article contents exists in some dictionaries
206	Article contents not found (partial content)	Contents of articles do not exist in all dictionaries

Sample:

Request:

GET /articles?contents&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "contents": [ { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?contents&limit=140&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show all articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List articles of the current dictionary's id. Default limit is 100

List articles of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/articles/{dictionary_id}?limit={limit}&sort={sort}&page={page_number}&{resume}

https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?limit={limit}&sort={sort}&page={page_number}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)
page_number	integer	Optional	Page number to charge
resume	boolean	Optional	Show the resume version of data

Response:

Body:

{
"articles": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Articles found	Articles of current dictionary exist
200	Articles found	Articles of current dictionary exists
206	Articles not found	Article of current dictionary does not exist or dictionary's id is invalid
206	Articles not found (partial content)	Articles of current dictionary do not exist or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031?limit=42&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "articles": [ { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /articles/yb_fr_3031?limit=42&sort=ASC&page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "articles": [ { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" }, { "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" } ] }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?limit=42&sort=ASC&page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show all articles from dictionaries

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List articles of all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/articles?limit={limit}&sort={sort}&{resume} https://apis.ntealan.net/ntealan/dictionaries/articles?limit={limit}&sort={sort}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)
resume	string	Optional	Resume the content of the data

Response:

Body:

{
"articles": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Articles found	Articles of current dictionary exists
206	Articles not found (partial content)	Articles of current dictionary do not exist

Sample:

Request:

GET /articles?limit=150&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /articles?limit=150&sort=ASC&my_resume HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles?limit=150&sort=ASC&my_resume HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"article": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article found	Article of current dictionary exists
206	Article not found (partial content)	Article of current dictionary does not exist or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/25 HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/25 HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Show categories of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List article categories of all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?cats&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?cats&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"categories": [
CategoryObject
]
}

Codes:

Code	Message	Description
200	Article categories found	Article categories exists in some dictionaries
206	Article categories not found (partial content)	Categories of articles do not exist in all dictionaries

Sample:

Request:

GET /articles?cats&limit=40&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "categories": [ { "category": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "category": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?cats&limit=40&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show categories of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List categories of article for the current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?cats&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?cats&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"categories": [
CategoryObject
]
}

Codes:

Code	Message	Description
200	Article categories found	Article categories exists for current dictionary
206	Article categories not found (pârtial content)	Article categories do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?cats&limit=5&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?cats&limit=5&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show category of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article category of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?category https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?category

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"category": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article category found	Article category of current dictionary exists
206	Article category not found	Article category of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/364?category HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "category": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/364?category HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "category": { "type": "my_type" } }

Show class of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article class of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?class https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?class

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"class": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article class found	Article class of current dictionary exists
206	Article class not found	Article class of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/899?class HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "class": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/899?class HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "class": { "type": "my_type" } }

Show classes of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List grammatical classes (part of speech) of article for all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?classes&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?classes&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"classes": [
ClasssObject
]
}

Codes:

Code	Message	Description
200	Article classes found	Article classes exists in some dictionaries
206	Article classes not found (partial content)	Classes of articles do not exist in all dictionaries

Sample:

Request:

GET /articles?classes&limit=300&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "classes": [ { "data": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "data": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?classes&limit=300&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show classes of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List grammatical classes of articles for current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?classes&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?classes&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"classes": [
ClasssObject
]
}

Codes:

Code	Message	Description
200	Article classes found	Article classes exists for current dictionary
206	Article classes not found (partial content)	Classes of articles do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?classes&limit=50&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?classes&limit=50&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show content of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article content of the current article's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?content https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?content

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"article": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article content found	Article content of current dictionary exists
206	Article content not found	Article content of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/543?content HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/543?content HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Show contents of articles for a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List contents of article for the current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?contents&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?contents&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"contents": [
ArticleObject
]
}

Codes:

Code	Message	Description
200	Article contents found	Article contents exists for current dictionary
206	Article contents not found (partial content)	Article contents do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?contents&limit=61&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?contents&limit=61&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show entries of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List entries of articles for all available dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?entries&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?entries&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"entries": [
EntryObject
]
}

Codes:

Code	Message	Description
200	Article entries found	Article entries exists in some dictionaries
206	Article entries not found (partial content)	Entries of articles do not exist in all dictionaries

Sample:

Request:

GET /articles?entries&limit=15&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "entries": [ { "entry": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "entry": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?entries&limit=15&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show entries of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List entries of articles for current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?entries&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?entries&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"entries": [
EntryObject
]
}

Codes:

Code	Message	Description
200	Article entries found	Article entries exists for current dictionary
206	Article entries not found (partial content)	Entries of articles do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?entries&limit=63&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?entries&limit=63&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show entry of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article entry of the current article's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?entry https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?entry

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"entry": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article found	Article entry of current dictionary exists
404	Article entry not found	Article entry of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/456?entry HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "entry": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/456?entry HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "entry": { "type": "my_type" } }

Show example of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article example of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?example https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?example

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"form": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article example found	Article example of current dictionary exists
206	Article example not found	Article example of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/129?example HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "form": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/129?example HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "form": { "type": "my_type" } }

Show examples of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List article examples for all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?examples&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?examples&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"examples": [
ExampleObject
]
}

Codes:

Code	Message	Description
200	Article examples found	Article examples exists in some dictionaries
206	Article examples not found (partial content)	Examplesof articles do not exist in all dictionaries

Sample:

Request:

GET /articles?examples&limit=91&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "examples": [ { "example": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "example": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?examples&limit=91&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show examples of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List examples of articles (contextualisation) for the current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?examples&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?examples&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"examples": [
ExampleObject
]
}

Codes:

Code	Message	Description
200	Article examples found	Article examples exists for current dictionary
206	Article examples not found (partial content)	Article examples do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?examples&limit=50&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?examples&limit=50&sort=DESC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show forms of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List article forms for all dictionaries. These forms can be 'simple' or 'compound'

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?forms&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?forms&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"forms": [
FormObject
]
}

Codes:

Code	Message	Description
200	Article forms found	Article forms exists in some dictionaries
206	Article forms not found (partial content)	Article forms do not exist in all dictionaries

Sample:

Request:

GET /articles?forms&limit=505&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "forms": [ { "form": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }, { "form": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" } ] }

Sample:

Request:

GET /dictionaries/articles?forms&limit=505&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show forms of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List article forms for the current dictionary. These forms can be 'simple' or 'compound'

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?forms&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?forms&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"forms": [
FormObject
]
}

Codes:

Code	Message	Description
200	Article forms found	Article forms exists for cuurent dictionay
206	Article forms not found (partial content)	Article forms do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?forms&limit=42&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?forms&limit=42&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show translation of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article translate of the current dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?trad={lang} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?trad={lang}

URI Parameters:

Parameter	Type	Description
dictionary_id	integer	Dictionary Id
article_id	integer	Article Id
lang	enum	List of accept languages

Response:

Body:

{
"translate": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article translate found	Article translate of current dictionary exists
206	Article translate not found	Article translate of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/247?trad=fr HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "translate": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/247?trad=fr HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "translate": { "type": "my_type" } }

Show translations of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List the possible translations of articles in all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/articles?trads={lang}&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles?trads={lang}&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
lang	enum		List of accept languages (ko, fr, es, en)
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"translation": [
TranslateObject
]
}

Codes:

Code	Message	Description
200	Article translations found	Article translations exists in some dictionaries
206	Article translations not found (partial content)	Translations of articles do not exist in all dictionaries

Sample:

Request:

GET /articles?trads=en&limit=360&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "translation": [ { "id_article": 42, "id_dico": "my_id_dico", "trad_en": "my_trad_en", "trad_es": "my_trad_es", "trad_fr": "my_trad_fr", "trad_ko": "my_trad_ko" }, { "id_article": 42, "id_dico": "my_id_dico", "trad_en": "my_trad_en", "trad_es": "my_trad_es", "trad_fr": "my_trad_fr", "trad_ko": "my_trad_ko" } ] }

Sample:

Request:

GET /dictionaries/articles?trads=en&limit=360&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show translations of articles

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List translations of articles for the current dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}?trads={lang}&limit={limit}&sort={sort} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}?trads={lang}&limit={limit}&sort={sort}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
lang	enum		List of accept languages
limit	integer	Optional	Limit range of articles to return
sort	string	Optional	Sort direction of results (ASC or DESC)

Response:

Body:

{
"translation": [
TranslateObject
]
}

Codes:

Code	Message	Description
200	Article translations found	Article translations exists for current dictionary
206	Article translations not found (partial content)	Article translations do not exist in current dictionary

Sample:

Request:

GET /articles/yb_fr_3031?trads=fr&limit=10&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031?trads=fr&limit=10&sort=ASC HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

Show type of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show an article type (category) of the current article's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id}?type https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}?type

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Response:

Body:

{
"type": {
"type": any
}
}

Codes:

Code	Message	Description
200	Article type found	Article type of current dictionary exists
206	Article not found (partial content)	Article type of current dictionary does not exist or dictionary's id is invalid

Sample:

Request:

GET /articles/yb_fr_3031/1031?type HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "type": { "type": "my_type" } }

Sample:

Request:

GET /dictionaries/articles/yb_fr_3031/1031?type HTTP/1.1 Content-Type: application/json; charset=utf-8

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "type": { "type": "my_type" } }

Update content of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Update an article content of the current article's id

Request:

Resource:

https://apis.ntealan.net/ntealan/articles/{dictionary_id}/{article_id} https://apis.ntealan.net/ntealan/dictionaries/articles/{dictionary_id}/{article_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id
article_id	integer		Article Id

Headers:

Parameter	Type	Description
Accept	mimeType	List of accepted MimeTypes
X-Access-Token	string	Authentication token

Response:

Body:

{
"article": {
"type": any
}
}

Codes:

Code	Message	Description
201	Article updated	Article content is correctly updated of current dictionary exists
401	Unauthorized to update Article	Only admin user with token can update article of the current dictionary
404	Article content not found	Article content of current dictionary does not exists or dictionary's id is invalid

Sample:

Request:

PUT /articles/yb_fr_3031/2513 HTTP/1.1 Content-Type: application/json; charset=utf-8 Accept: application/json X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Sample:

Request:

PUT /dictionaries/articles/yb_fr_3031/2513 HTTP/1.1 Content-Type: application/json; charset=utf-8 Accept: application/json X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "article": { "type": "my_type" } }

Comments

Manage comments of articles

Show All comments of articles for a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Get comments of a dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/comments/{dictionary_id}?page={page_number}&{resume} https://apis.ntealan.net/ntealan/dictionaries/comments/{dictionary_id}?page={page_number}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Public dictionary Id
page_number	integer	Optional	Page number to charge
resume	boolean	Optional	Show the resume version of data

Query String Parameters:

Parameter	Type	Optional	Description
article_id	integer		Public article Id

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"comments": Comment	Comment data
}

Codes:

Code	Message	Description
200	Comments found	Comments are found in articles in this dictionary
206	Comment Not Found	Comments are not found in articles in this dictionary

Sample:

Request:

GET /comments/yb_fr_3031?page=14&Truearticle_id=42 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "comments": { "avatar": "my_avatar", "data": "my_data", "disable_comment": true, "id_article": "my_id_article", "id_dico": "my_id_dico", "last_update": "my_last_update", "like": 42, "public_id": "my_public_id", "send_date": "my_send_date", "unlike": 42, "user_id": "my_user_id", "username": "my_username" } }

Sample:

Request:

GET /dictionaries/comments/yb_fr_3031?page=14&Truearticle_id=42 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Show All comments of dictionaries

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Get comments of articles for all dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/comments?page={page_number}&{resume} https://apis.ntealan.net/ntealan/dictionaries/comments?page={page_number}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
page_number	integer	Optional	Page number to charge
resume	boolean	Optional	Show the resume version of data

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"comments": Comment	Comment data
}

Codes:

Code	Message	Description
200	Comments found	Comments found in articles of somes dictionaries
206	Comment Not Found	Comments are not found in articles of all dictionaries

Sample:

Request:

GET /comments?page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Sample:

Request:

GET /dictionaries/comments?page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Show comments of article

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Get comments of an article of dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/comments/{dictionary_id}/{article_id}?page={page_number}&{resume} https://apis.ntealan.net/ntealan/dictionaries/comments/{dictionary_id}/{article_id}?page={page_number}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Public dictionary Id
article_id	integer		Public article Id
page_number	integer	Optional	Page number to charge
resume	boolean	Optional	Show the resume version of data

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"comments": Comment	Comment data
}

Codes:

Code	Message	Description
200	Comments found	Comment found
206	Forbidden	Comment found

Sample:

Request:

GET /comments/yb_fr_3031/42?page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Sample:

Request:

GET /dictionaries/comments/yb_fr_3031/42?page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Login

Manage authentication of user

Login a user

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Get Authentification token of user

Get login of user

Request:

Resource:

https://apis.ntealan.net/ntealan/login https://apis.ntealan.net/ntealan/core/login

Headers:

Parameter	Type	Description
Basic-Auth	object	User informations login

Response:

Body:

{
"token": string,	String authentification token of user
"user": User,	Informations of user
"user": User,	User data
"validity": string	Limited time of authentification token of user (30 minutes)
}

Codes:

Code	Message	Description
200	Token generated	Get a Authentification token for user
401	Unauthorized	User data no match
403	Forbidden	Current user can not be logging
403	Forbidden	Current user can not be logging ! invalid user informations

Sample:

Request:

GET /login HTTP/1.1 Content-Type: application/json; charset=utf-8 Basic-Auth: my_Basic-Auth

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "token": "my_token", "user": { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" }, "validity": "30 minutes" }

Sample:

Request:

POST /login HTTP/1.1 Content-Type: application/json; charset=utf-8 Basic-Auth: my_Basic-Auth

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "token": "my_token", "user": { "address": "my_address", "for_lang": "my_for_lang", "name": "my_name", "nat_lang": "my_nat_lang", "public_id": 42, "username": "my_username" }, "validity": "30 minutes" }

Sample:

Request:

POST /core/login HTTP/1.1 Content-Type: application/json; charset=utf-8 Basic-Auth: my_Basic-Auth

Response:

Metadata

Manage metadata of dictionaries

Create metadata of a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Create an new metadata of dictionary

Request:

Resource:

https://apis.ntealan.net/ntealan/metadata https://apis.ntealan.net/ntealan/dictionaries/metadata

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Body:

Metadata

Response:

Body:

{
"metadata": Metadata
}

Codes:

Code	Message	Description
201	Metadata created	Create new metadata of a dictionary
401	Unauthorized to create Metadata	Only admin user with valid token can create metadata of a dictionary
403	Forbidden	Metadata can not be adding to this dictionary. May be already exist

Sample:

Request:

POST /metadata HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token { "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" }

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "metadata": { "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" } }

Sample:

Request:

POST /dictionaries/metadata HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token { "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" }

Response:

Show metadata of a dictionaries

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List all metadata of dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/metadata https://apis.ntealan.net/ntealan/dictionaries/metadata

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"metadata": [
Metadata
],
"status": integer,
"total": integer
}

Codes:

Code	Message	Description
200	Metadata found	List of metadata found
401	Unauthorized to get metadata	Only admin user with valid token can get all metadata
403	Forbidden	Current user can not be getting metadata
404	Metadata not found	Metadata does not exists

Sample:

Request:

GET /metadata HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "metadata": [ { "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" }, { "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" } ], "status": 42, "total": 42 }

Sample:

Request:

GET /dictionaries/metadata HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Show metadata of a dictionary

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Show a metadata of dictionary's id

Request:

Resource:

https://apis.ntealan.net/ntealan/metadata/{dictionary_id} https://apis.ntealan.net/ntealan/dictionaries/metadata/{dictionary_id}

URI Parameters:

Parameter	Type	Optional	Description
dictionary_id	integer		Dictionary Id

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"metadata": Metadata
}

Codes:

Code	Message	Description
200	Metadata found	List of metadata found
401	Unauthorized to get metadata	Only admin user with valid token can get a metadata
403	Forbidden	Current user can not be getting metadata
404	Metadata not found	Metadata does not exists

Sample:

Request:

GET /metadata/yb_fr_3031 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Sample:

Request:

GET /dictionaries/metadata/yb_fr_3031 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

Users

Create a new user

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Create a new user

Request:

Resource:

https://apis.ntealan.net/ntealan/users

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Body:

User

Response:

Body:

User

Codes:

Code	Message	Description
201	User created	A new user is created
401	Unauthorized to get user	Only admin user with valid token can delete an user
403	Forbidden	Current user informations can not be use

Sample:

Request:

GET /users HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" }

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" }

Show all users

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

List users of dictionary

List users of dictionaries

Request:

Resource:

https://apis.ntealan.net/ntealan/users https://apis.ntealan.net/ntealan/users?page={page_number}&{resume}

URI Parameters:

Parameter	Type	Optional	Description
page_number	integer	Optional	Page number to charge
resume	boolean	Optional	Show the resume version of data

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"status": integer,
"total": integer,
"users": [
User
]
}

Codes:

Code	Message	Description
200	Users found	Show all users found for dictionaries
401	Unauthorized to get user	Only admin user with valid token can get all user
403	Forbidden	Current user can not be getting all users of dictionaries
403	Forbidden	Current user cannot get all users of dictionaries
404	User's id not found	User's id does not exists

Sample:

Request:

GET /users HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 42, "total": 42, "users": [ { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" }, { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" } ] }

Sample:

Request:

GET /users?page=14&True HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "status": 42, "total": 42, "users": [ { "address": "my_address", "for_lang": "my_for_lang", "name": "my_name", "nat_lang": "my_nat_lang", "public_id": 42, "username": "my_username" }, { "address": "my_address", "for_lang": "my_for_lang", "name": "my_name", "nat_lang": "my_nat_lang", "public_id": 42, "username": "my_username" } ] }

Show user

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Retrieve properties of a specific user

Request:

Resource:

https://apis.ntealan.net/ntealan/users/{user_id}

URI Parameters:

Parameter	Type	Optional	Description
user_id	integer		user identifier

Headers:

Parameter	Type	Description
X-Access-Token	string	Authentication token

Response:

Body:

{
"User": User
}

Codes:

Code	Message	Description
200	User found	Show properties of user found
401	Unauthorized to get user	Only admin user with valid token can get an user
403	Forbidden	Current user can not be getting a user
404	User's id not found	User's id does not exists

Sample:

Request:

GET /users/42 HTTP/1.1 Content-Type: application/json; charset=utf-8 X-Access-Token: my_X-Access-Token

Response:

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "User": { "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" } }

Articles

Manage articles of all dictionaries
- mimeType
  Diff
  - v1.0
  - v2.0
  - v3.0
  - v3.1
  no implementation for this version
  
  A mime type
  
  Presentation:
  
  string
  
  Formats:
  
  Pretty Print:
  type/sous-type
  Sample:
  
  "application/json"

ArticleObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object article of dictionary

Presentation:

{
"all_raw_text": string,	Article content data
"article": {	content of article
"type": any
},
"article_page": integer,	Article pagination
"disable_article": boolean,	Article status
"id_article": integer,	Article identifier
"id_dico": string,	Dictionary identifier
"like": integer,	Number of like for an article
"public_id": string,	Article identifier
"radical": string,	radical for an article
"unlike": integer,	External users version of article
"users_versions": string	External users version of article
}

Formats:

Sample:

{ "article": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

Formats:

Sample:

{ "all_raw_text": "my_all_raw_text", "article": { }, "article_page": 42, "disable_article": true, "id_dico": "my_id_dico", "like": 42, "public_id": "my_public_id", "radical": "my_radical", "unlike": 42, "users_versions": "my_users_versions" }

CategoryObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object of article categories of all dictionaries

Presentation:

{
"category": {	Content of article category
"type": any
},
"id_article": integer,	Article identifier
"id_dico": string	Dictionary identifier
}

Formats:

Sample:

{ "category": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

ClasssObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object of article grammatical class for dictionaries

Presentation:

{
"data": {	Content of grammatical class
"type": any
},
"id_article": integer,	Article identifier
"id_dico": string	Dictionary identifier
}

Formats:

Sample:

{ "data": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

Comment

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

Comment about an article

Presentation:

{
"avatar": string,	avatar of the commentator
"data": string,	Content data of comment
"disable_comment": boolean,	Last update date
"id_article": string,	Identified of article
"id_dico": string,	Identified of dictionary
"last_update": string,	Last update date
"like": integer,	like comment
"public_id": string,	Public id of comment
"send_date": string,	Send date
"unlike": integer,	Unlike comment
"user_id": string,	User public id
"username": string	User name
}

Formats:

Sample:

{ "data": "my_data", "id_article": "my_id_article", "id_dico": "my_id_dico", "last_update": "my_last_update", "public_id": "my_public_id", "send_date": "my_send_date", "user_id": "my_user_id", "username": "my_username" }

Formats:

Sample:

{ "avatar": "my_avatar", "data": "my_data", "disable_comment": true, "id_article": "my_id_article", "id_dico": "my_id_dico", "last_update": "my_last_update", "like": 42, "public_id": "my_public_id", "send_date": "my_send_date", "unlike": 42, "user_id": "my_user_id", "username": "my_username" }

EntryObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object entry for article of dictionary

Presentation:

{
"entry": {	Content of entry
"type": any
},
"id_article": integer,	Article identifier
"id_dico": string	Dictionary identifier
}

Formats:

Sample:

{ "entry": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

Equivalent

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

A translation of entry in article

Presentation:

{
"content": string,	Value of translation of entry
"lang": integer,	Target translation language
"number": integer	Identifier of translation
}

Formats:

Sample:

{ "content": "my_content", "lang": 42, "number": 42 }

Example
Diff
- v1.0
- v2.0
- v3.0
- v3.1
no implementation for this version

A translation of entry in article

Presentation:

{

"type": any

}

Formats:

Sample:

{ "type": "my_type" }

ExampleObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object of article example of all dictionaries

Presentation:

{
"example": {	Content of article example
"type": any
},
"id_article": integer,	Article identifier
"id_dico": string	Dictionary identifier
}

Formats:

Sample:

{ "example": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

FormObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object of article forms of dictionaries

Presentation:

{
"form": {	Content of article form
"type": any
},
"id_article": integer,	Article identifier
"id_dico": string	Dictionary identifier
}

Formats:

Sample:

{ "form": { "type": "my_type" }, "id_article": 42, "id_dico": "my_id_dico" }

Metadata

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

A global informations about a dictionary

Presentation:

{
"abbr_name": string,	Abreviation form of dictionary name
"comment": string,	Comment about revision of dictionary
"description": string,	Description of dictionary
"id_dico": string,	Identified of dictionary
"long_name": string,	Long version of dictionary name
"publication": string,	Some publication sources related to dictionary
"review_version": string,	Version of revision of dictionary
"review_year": string,	Date of revision of dictionary (ntealan transform)
"short_name": string,	Short version of dictionary name
"source": string,	Source of dictionary
"src_authors": string,	Source authors of the first version of dictionary
"trg_authors": string	Target authors of the new version of dictionary
}

Formats:

Sample:

{ "abbr_name": "my_abbr_name", "comment": "my_comment", "description": "my_description", "id_dico": "my_id_dico", "long_name": "my_long_name", "publication": "my_publication", "review_version": "my_review_version", "review_year": "my_review_year", "short_name": "my_short_name", "source": "my_source", "src_authors": "my_src_authors", "trg_authors": "my_trg_authors" }

TranslateObject

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

An object of article translation of all dictionaries

Presentation:

{
"id_article": integer,	Article identifier
"id_dico": string,	Dictionary identifier
"trad_en": string,	Translation of article entry into english
"trad_es": string,	Translation of article entry into spanish
"trad_fr": string,	Translation of article entry into french
"trad_ko": string	Translation of article entry into ko
}

Formats:

Sample:

{ "id_article": 42, "id_dico": "my_id_dico", "trad_en": "my_trad_en", "trad_es": "my_trad_es", "trad_fr": "my_trad_fr", "trad_ko": "my_trad_ko" }

User

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

A user

Presentation:

{
"address": string,	Adresse of the user
"for_lang": string,	Foreigner language of the user
"name": string,	Name of the user
"nat_lang": string,	Mother toungue of the user
"native_lang": string,	Mother toungue of the user
"public_id": integer,	User identifier
"username": string	Username of the user
}

Formats:

Sample:

{ "address": "my_address", "name": "my_name", "native_lang": "my_native_lang", "public_id": 42, "username": "my_username" }

Formats:

Sample:

{ "address": "my_address", "for_lang": "my_for_lang", "name": "my_name", "nat_lang": "my_nat_lang", "public_id": 42, "username": "my_username" }

Variant

Diff

v1.0
v2.0
v3.0
v3.1

no implementation for this version

A dialectal variant of entry

Presentation:

{
"forme": string,	Form of dialectal variant
"prefix": string,	Prefix of dialectal variant
"radical": string,	Radical of dialectal variant
"suffix": string,	Suffix of dialectal variant
"type": string	Identifier of dialectal variant
}

Formats:

Sample:

{ "forme": "my_forme", "prefix": "my_prefix", "radical": "my_radical", "suffix": "my_suffix", "type": "my_type" }

NTeALan API for african language dictionaries

Versions

Methods

Articles

Comments

Login

Metadata

Users

Types

Articles

hello

Methods

Articles

Create new article of a dictionary

Diff

Request:

Resource:

URI Parameters:

Headers:

Response:

Body:

Codes:

Sample:

Request:

Response:

Sample:

Request:

Response:

Delete all articles of a dictionary

Diff

Request:

Resource:

URI Parameters:

Query String Parameters:

Headers:

Response:

Body:

Codes:

Sample:

Request:

Response:

Sample:

Request:

Response:

Delete article of a dictionary

Diff

Request:

Resource:

URI Parameters:

Headers:

Response:

Body:

Codes:

Sample:

Request:

Response:

Sample:

Request:

Response:

Search articles in dictionaries

Diff

Request:

Resource:

URI Parameters:

Response:

Body:

Codes:

Sample:

Request:

Response:

Sample:

Request:

Response:

Search articles in dictionary

Diff

Request:

Resource:

URI Parameters:

Response:

Body: