Corpora Web API Help Page

Introduction

Corpora Web API implements set of REST web services which provides access to backend busness logic for web and mobile client applications.

Annotation

API	Authorize	Description
GET annotation/count?distinct={distinct}&token={token}&match={match}&tokenOnly={tokenOnly}&status={status}&dialectID={dialectID}&partID={partID}&formID={formID}&comm={comm}	Reviewer	No documentation available.
GET annotation/search?token={token}&match={match}&tokenOnly={tokenOnly}&edited={edited}&status={status}&dialectID={dialectID}&partID={partID}&formID={formID}&comm={comm}&skip={skip}&take={take}	Reviewer	No documentation available.
GET annotation/dialect/{dialectID}/token/{tokenID}	Reviewer	No documentation available.
GET annotation/{id}	Reviewer	No documentation available.
DELETE annotation/{id}	Operator	No documentation available.
POST annotation/save	Operator	No documentation available.
POST annotation/generate/{dialectID}	Operator	No documentation available.
GET annotation/generate/{dialectID}	Anonymous	No documentation available.
POST annotation/download?token={token}&match={match}&tokenOnly={tokenOnly}&status={status}&dialectID={dialectID}&partID={partID}	Reviewer	No documentation available.
POST annotation/upload/{dialectID}	Operator	No documentation available.
GET annotation/contexts/{dialectID}/{tokenID}/{skip}/{take}?isAnnotated={isAnnotated}	Reviewer	No documentation available.
POST annotation/annotate/batch/{annotationID}	Operator	No documentation available.
PUT annotation/annotate/{contextBreakdownID}/{annotationID}	Operator	No documentation available.
POST annotation/annotate	Operator	No documentation available.
POST annotation/paste	Operator	No documentation available.
POST annotation/merge	Operator	No documentation available.
DELETE annotation/annotate/{contextBreakdownID}	Operator	No documentation available.

Account

API	Authorize	Description
POST account/login	Anonymous	No documentation available.
GET account/validate/{token}	Anonymous	No documentation available.
POST account/logout	Anonymous	No documentation available.

Publications

API	Authorize	Description
GET admin/publications	Admin	No documentation available.
GET admin/publications/{id}	Admin	No documentation available.
POST admin/publications	Admin	No documentation available.
DELETE admin/publications/{id}	Admin	No documentation available.

Users

API	Authorize	Description
GET admin/users	Admin	No documentation available.
GET admin/users/{id}	Admin	No documentation available.
POST admin/users	Admin	No documentation available.
DELETE admin/users/{id}	Admin	No documentation available.

Lists

API	Authorize	Description
GET admin/lookups/parts	Admin	No documentation available.
GET admin/lookups/parts/{id}	Admin	No documentation available.
POST admin/lookups/parts	Admin	No documentation available.
DELETE admin/lookups/parts/{id}	Admin	No documentation available.
GET admin/lookups/parts/{partID}/forms	Admin	No documentation available.
GET admin/lookups/forms/{id}	Admin	No documentation available.
POST admin/lookups/forms	Admin	No documentation available.
DELETE admin/lookups/forms/{id}	Admin	No documentation available.
GET admin/lookups/parts/{partID}/semantics	Admin	No documentation available.
GET admin/lookups/semantics/{id}	Admin	No documentation available.
POST admin/lookups/semantics	Admin	No documentation available.
DELETE admin/lookups/semantics/{id}	Admin	No documentation available.
GET admin/lookups/word-compositions	Admin	No documentation available.
GET admin/lookups/word-compositions/{id}	Admin	No documentation available.
POST admin/lookups/word-compositions	Admin	No documentation available.
DELETE admin/lookups/word-compositions/{id}	Admin	No documentation available.
GET admin/lookups/foreign-languages	Admin	No documentation available.
GET admin/lookups/foreign-languages/{id}	Admin	No documentation available.
POST admin/lookups/foreign-languages	Admin	No documentation available.
DELETE admin/lookups/foreign-languages/{id}	Admin	No documentation available.
GET admin/lookups/lexical-types	Admin	No documentation available.
GET admin/lookups/lexical-types/{id}	Admin	No documentation available.
POST admin/lookups/lexical-types	Admin	No documentation available.
DELETE admin/lookups/lexical-types/{id}	Admin	No documentation available.
GET admin/lookups/lexical-types/{typeID}/lexical-sub-types	Admin	No documentation available.
GET admin/lookups/lexical-types/{typeID}/lexical-sub-types/{id}	Admin	No documentation available.
POST admin/lookups/lexical-types/{typeID}/lexical-sub-types	Admin	No documentation available.
DELETE admin/lookups/lexical-types/{typeID}/lexical-sub-types/{id}	Admin	No documentation available.
GET admin/lookups/subject-groups	Admin	No documentation available.
GET admin/lookups/subject-groups/{id}	Admin	No documentation available.
POST admin/lookups/subject-groups	Admin	No documentation available.
DELETE admin/lookups/subject-groups/{id}	Admin	No documentation available.
GET admin/lookups/subject-groups/{groupID}/subjects	Admin	No documentation available.
GET admin/lookups/subject-groups/{groupID}/subjects/{id}	Admin	No documentation available.
POST admin/lookups/subject-groups/{groupID}/subjects	Admin	No documentation available.
DELETE admin/lookups/subject-groups/{groupID}/subjects/{id}	Admin	No documentation available.
GET admin/lookups/languages	Admin	No documentation available.
GET admin/lookups/languages/{id}	Admin	No documentation available.
POST admin/lookups/languages	Admin	No documentation available.
DELETE admin/lookups/languages/{id}	Admin	No documentation available.
GET admin/lookups/languages/{languageID}/dialects	Admin	No documentation available.
GET admin/lookups/languages/{languageID}/dialects/{id}	Admin	No documentation available.
POST admin/lookups/languages/{languageID}/dialects	Admin	No documentation available.
DELETE admin/lookups/languages/{languageID}/dialects/{id}	Admin	No documentation available.
GET admin/lookups/languages/{languageID}/dialects/{dialectID}/sub-dialects	Admin	No documentation available.
GET admin/lookups/languages/{languageID}/dialects/{dialectID}/sub-dialects/{id}	Admin	No documentation available.
POST admin/lookups/languages/{languageID}/dialects/{dialectID}/sub-dialects	Admin	No documentation available.
DELETE admin/lookups/languages/{languageID}/dialects/{dialectID}/sub-dialects/{id}	Admin	No documentation available.
GET admin/lookups/countries	Admin	No documentation available.
GET admin/lookups/countries/{id}	Admin	No documentation available.
POST admin/lookups/countries	Admin	No documentation available.
DELETE admin/lookups/countries/{id}	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces/{id}	Admin	No documentation available.
POST admin/lookups/countries/{countryID}/provinces	Admin	No documentation available.
DELETE admin/lookups/countries/{countryID}/provinces/{id}	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces/{provinceID}/districts	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{id}	Admin	No documentation available.
POST admin/lookups/countries/{countryID}/provinces/{provinceID}/districts	Admin	No documentation available.
DELETE admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{id}	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{districtID}/towns	Admin	No documentation available.
GET admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{districtID}/towns/{id}	Admin	No documentation available.
POST admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{districtID}/towns	Admin	No documentation available.
DELETE admin/lookups/countries/{countryID}/provinces/{provinceID}/districts/{districtID}/towns/{id}	Admin	No documentation available.

SmlTexts

API	Authorize	Description
GET sml/texts/titles/search/{title}?authorID={authorID}&subjectID={subjectID}&genreID={genreID}&mediaID={mediaID}&languageID={languageID}&publicationID={publicationID}&skip={skip}&take={take}&previewLength={previewLength}	Anonymous	No documentation available.
GET sml/texts/search?title={title}&authorID={authorID}&subjectID={subjectID}&genreID={genreID}&mediaID={mediaID}&languageID={languageID}&publicationID={publicationID}&skip={skip}&take={take}&previewLength={previewLength}	Anonymous	No documentation available.
GET sml/texts/{id}	Anonymous	No documentation available.
POST sml/texts/upload/pdf/{id}	Operator	No documentation available.
POST sml/texts/upload/txt/{id}	Operator	No documentation available.
GET sml/texts/{id}/pdf	Anonymous	No documentation available.
POST sml/texts/save	Operator	No documentation available.
GET sml/texts/authors/search/{term}	Anonymous	No documentation available.
GET sml/texts/authors/{id}	Anonymous	No documentation available.
POST sml/texts/authors/save	Operator	No documentation available.

Tokens

API	Authorize	Description
GET tokens/search?token={token}&match={match}&skip={skip}&take={take}	Reviewer	No documentation available.

SmlCorpus

API	Authorize	Description
GET sml/corpus/search?token={token}&match={match}&lemmaOnly={lemmaOnly}&partID={partID}&formID={formID}&subjectID={subjectID}&authorID={authorID}&languageID={languageID}&publicationID={publicationID}&title={title}&stat={stat}&skip={skip}&take={take}	Anonymous	No documentation available.
GET sml/corpus/contexts?tokenID={tokenID}&partID={partID}&formID={formID}&subjectID={subjectID}&authorID={authorID}&languageID={languageID}&publicationID={publicationID}&title={title}&stat={stat}&skip={skip}&take={take}	Anonymous	No documentation available.

Authors

API	Authorize	Description
GET admin/authors	Admin	No documentation available.
GET admin/authors/{id}	Admin	No documentation available.
POST admin/authors	Admin	No documentation available.
DELETE admin/authors/{id}	Admin	No documentation available.

Lookups

API	Authorize	Description
GET lookups/wards?term={term}	Anonymous	No documentation available.
GET lookups/wards/{term}	Anonymous	No documentation available.
GET lookups/lenguas?term={term}	Anonymous	No documentation available.
GET lookups/lenguas/{term}	Anonymous	No documentation available.
GET lookups/subjects?term={term}	Anonymous	No documentation available.
GET lookups/subjects/{term}	Anonymous	No documentation available.
GET lookups/genres	Anonymous	No documentation available.
GET lookups/medias	Anonymous	No documentation available.
GET lookups/ethnicities?term={term}	Anonymous	No documentation available.
GET lookups/ethnicities/{term}	Anonymous	No documentation available.
GET lookups/nationalities	Anonymous	No documentation available.
GET lookups/languages	Anonymous	No documentation available.
GET lookups/parts	Anonymous	No documentation available.
GET lookups/parts/{partID}/forms	Anonymous	No documentation available.
GET lookups/parts/{partID}/semantics	Anonymous	No documentation available.
GET lookups/lex/compositions	Anonymous	No documentation available.
GET lookups/lex/types	Anonymous	No documentation available.
GET lookups/lex/types/{typeID}/subtypes	Anonymous	No documentation available.
GET lookups/dictionaries	Anonymous	No documentation available.
GET lookups/dialects	Anonymous	No documentation available.
GET lookups/publications?options={options}	Anonymous	No documentation available.
GET lookups/authors?term={term}	Anonymous	No documentation available.
GET lookups/authors/{term}	Anonymous	No documentation available.

Test

API	Authorize	Description
GET test/do	Anonymous	No documentation available.

Dictionaries

API	Authorize	Description
GET dictionaries/search?token={token}&match={match}&lemmaOnly={lemmaOnly}&status={status}&dialectID={dialectID}&partID={partID}&publicationID={publicationID}&subjectID={subjectID}&authorID={authorID}&languageID={languageID}&skip={skip}&take={take}	Anonymous	No documentation available.
GET dictionaries/search/count?token={token}&match={match}&lemmaOnly={lemmaOnly}&status={status}&dialectID={dialectID}&partID={partID}&publicationID={publicationID}&subjectID={subjectID}&authorID={authorID}&languageID={languageID}	Anonymous	No documentation available.
GET dictionaries/articles/{tokenID}?dialectID={dialectID}	Anonymous	No documentation available.
GET dictionaries/article/{id}	Anonymous	No documentation available.
DELETE dictionaries/article/{id}	Reviewer	No documentation available.
POST dictionaries/article/save	Operator	No documentation available.

Corpus

API	Authorize	Description
GET corpus/stat	Anonymous	No documentation available.
GET corpus/search?token={token}&match={match}&partID={partID}&formID={formID}&wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}&skip={skip}&take={take}	Anonymous	No documentation available.
GET corpus/search/count?token={token}&match={match}&partID={partID}&formID={formID}&wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}	Anonymous	No documentation available.
GET corpus/contexts?tokenID={tokenID}&partID={partID}&formID={formID}&wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}&skip={skip}&take={take}	Anonymous	No documentation available.
GET corpus/contexts/count?tokenID={tokenID}&partID={partID}&formID={formID}&wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}	Anonymous	No documentation available.

ListsGis

API	Authorize	Description
GET admin/lookups/gis/towns	Admin	No documentation available.

DialectTexts

API	Authorize	Description
GET texts/dialect/search?wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}&publicationID={publicationID}&skip={skip}&take={take}&previewLength={previewLength}	Anonymous	No documentation available.
GET texts/dialect/{id}	Anonymous	No documentation available.
POST texts/dialect/save	Operator	No documentation available.
GET texts/dialect/narrators/search/{term}	Anonymous	No documentation available.
GET texts/dialect/narrators/{id}	Anonymous	No documentation available.
POST texts/dialect/narrators/save	Operator	No documentation available.

DialectTextsGis

API	Authorize	Description
GET texts/dialect/gis/load?wardID={wardID}&lenguaID={lenguaID}&subjectID={subjectID}&narratorID={narratorID}&publicationID={publicationID}	Anonymous	No documentation available.