Skip to content

Service: User Setting Retrieval

Eliza Margaretha edited this page Feb 5, 2019 · 4 revisions

** WARNING: This service is experimental and may change without any notice.

Retrieves settings of a user. User settings contains user preferences for various default settings, for instance default foundries for specific layers such as lemma and part of speech.

Available in: full version

Method: GET

Service URL: {root}/{api-version}/~{username}/setting

Parameters

Path parameters

name required description type example
root yes the service root URI String http://localhost:8089/api
api-version yes the version of the API String v1.0
username yes the username must be the same as the authenticated username String

Header Parameters

Name Required Description Value
Authorization yes HTTP authentication with schemes: Api, Bearer user authentication token: Api token, OAuth2 access token (Bearer)

Examples

In the following example, multiple values are separated by empty space, see "metadata".

curl -H 'Authorization: Api eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo'     
      http://localhost:8089/api/v1.0/~dory/setting

Response

This is only an example. Setting keys are not strictly defined.

{
    "pos-foundry": "marmot",
    "resultPerPage": "25",
    "metadata": "author title textSigle availability"
}

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus services

Virtual corpus access services

Administrative services

Description services

Clone this wiki locally