<div style="border:1px solid #f5c6cb; background:#f8d7da; padding:10px; margin:10px 0;">
'''Attenzione:''' Le ricerche root <code>/works</code>, <code>/instances</code>,
<code>/items</code> e <code>/dates</code> richiedono il ruolo '''svde-editor-base''' e non sono
accessibili con il solo scope <code>svde-resource-read</code>. Un integratore di sola lettura deve
usare la navigazione gerarchica.
</div>

==Stats==
The /stats endpoint returns high-level aggregations about the whole knowledge base. There's an "extended" boolean parameter which drives the response format, specifically:

When it is set to false, the response is very concise, see the following example:<syntaxhighlight lang="json">
{
"item": 137,
"agent": {
"person": 54,
"organization": 16,
"family": 16,
"meeting": 9
},
"instance": 146,
"opus": 120,
"work": 138,
"subject": 103
}
</syntaxhighlight>The response returns the counts for each entity type. The "agent" is actually a group that contains the agent types counts. It is possible to set a request parameter called "provenance" that will cause the response to return only provenance-specific values. The response in this case has exactly the same shape but counts refer only to the requested provenance. In case the extended parameter is set to true, then the response is more articulated because counts are broken by provenance:<syntaxhighlight lang="json">

"https://svde.org/agents/NLF": {
"item": 3,
"agent": {
"person": 4,
"organization": 2,
"family": 1
},
"instance": 4,
"work": 5,
"opus": 3,
"totalCount": 22
},
"https://svde.org/agents/NYU": {
"item": 7,
"agent": {
"person": 4,
"organization": 1,
"family": 3,
"meeting": 2
},
"instance": 7,
"work": 8,
"opus": 8,
"totalCount": 40
},
"https://svde.org/agents/NORTHWESTERN": {
"agent": {
"person": 1,
"meeting": 1
},
"instance": 1,
"work": 2,
"opus": 2,
"totalCount": 7
},
...
</syntaxhighlight>
==Resource==
A ShareVDE resource is an abstract and high-level concept which maps agents and opuses.

'''/resources'''

Simple search across Share-VDE resources.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|q
| String
|An agent query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
| 0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
| partialMatch
|Boolean
| Forces a partial match search (entered query terms are considered optional)
|0...1
|false
|-
|[[ShareDoc:API documentation#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}
==Agent==
The Agent is an abstract concept which concretely maps people, organisations, conferences, families, jurisdictions, etc., that play a role (or even multiple roles) such as authors, editors, distributors, illustrator, publisher, etc.

'''/agents'''

Fulltext or Typeahead search across Share-VDE agents.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
! '''Cardinality'''
!'''Default Value'''
|-
|q
|String
|An agent query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|mode
| Enum
|One among '''fts''' (fulltext search) and '''typeahead'''
|0...1
|fts
|-
|sort
| String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
|true
|-
| edits
|Integer
| Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|-
|partialMatch
|
|Forces a partial match search (simple search only)
|0...1
|false
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/agents/{agentId}'''

Returns the agent associated with the given identifier.

'''/agents/{agentId}/opuses'''

Returns the opuses of the agent associated with the given identifier.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
|role
|String
|The relator code used for refining the type of contribution
|0...1
|N.A.
|}'''Examples'''
*[https://sit2-base-svde.atcult.it/agents.json?q=agents%20whose%20name%20contains%20carroll Agents whose names contains carroll]
*[https://sit2-base-svde.atcult.it/agents.json?q=agents%20whose%20name%20contains%20carroll&sort=name%20asc&rows=2&offset=2 A sublist of all agents whose name contains carroll, sorted by name and paged]
*[https://sit2-base-svde.atcult.it/agents.json?q=carro&mode=typeahead Agents typeahead search using '''carro''']
*[https://sit2-base-svde.atcult.it/agents.json?q=carto&mode=typeahead&fuzzy=true Agents typeahead search using '''carto''' (fuzzy match)]
* [https://sit2-base-svde.atcult.it/agents.json?q=carto&mode=typeahead&fuzzy=false Agents typeahead search using '''carto''' (no fuzzy)]
*[https://sit2-base-svde.atcult.it/agents/201.json Lewis Carroll]
==Person==
A person is an individual or identity established by an individual (either alone or in collaboration with one or more other individuals). It is a concrete subclass of Agent and provides a set of attributes, both datatype and object properties which interconnect the entity to opuses and other bibliographic entities in the Share-VDE domain model.

'''/people'''

Fulltext or Typeahead search across Share-VDE people.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
! '''Cardinality'''
!'''Default Value'''
|-
|q
|String
|A people query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|mode
| Enum
|One among '''fts''' (fulltext search) and '''typeahead'''
|0...1
|fts
|-
|sort
| String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
| true
|-
|edits
|Integer
|Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|-
|partialMatch
|Boolean
|Forces a partial match search (simple search only)
| 0...1
|false
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/people/{id}'''

Returns the agent associated with the given identifier.

'''/people/{id}/opuses'''

Returns the opuses of the person associated with the given identifier.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
| A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
|role
|String
|The relator code used for refining the type of contribution
|0...1
|aut
|}'''/people/{id}/occupations'''

Returns the occupations of the person associated with the given identifier.

'''/people/{id}/occupations/{occupationId}'''

Returns the occupation (related with a specific person) associated with the given identifier.

'''Examples'''
*[https://sit2-base-svde.atcult.it/people.json?q=people%20whose%20name%20contains%20carroll People whose names contains carroll]
*[https://sit2-base-svde.atcult.it/people.json?q=people%20whose%20name%20contains%20carroll&sort=name%20asc&rows=2&offset=2 A sublist of all people whose name contains carroll, sorted by name and paged]
*[https://sit2-base-svde.atcult.it/people.json?q=carro&mode=typeahead People typeahead search using '''carro''']
*[https://sit2-base-svde.atcult.it/people.json?q=carto&mode=typeahead&fuzzy=true People typeahead search using '''carto''' (fuzzy match)]
*[https://sit2-base-svde.atcult.it/people.json?q=carto&mode=typeahead&fuzzy=false People typeahead search using '''carto''' (no fuzzy)]
*[https://sit2-base-svde.atcult.it/people/201.json Lewis Carroll]
*[https://sit2-base-svde.atcult.it/people/201/occupations.json Lewis Carroll's occupations]
*[https://sit2-base-svde.atcult.it/people/201/opuses.json Lewis Carroll's opuses]
==Meeting==
Gathering of individuals or representatives of various bodies for the purpose of discussing and/or acting on topics of common interest. It is a concrete subclass of Agent and provides a set of attributes, both datatype and object property which interconnect the entity to opuses and other bibliographic entities in the Share-VDE domain model.

'''/meetings'''

Fulltext or Typeahead search across Share-VDE meetings.
{| class="wikitable"
|+Request Parameters
!'''Name'''
! '''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|q
|String
|A meeting query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|mode
| Enum
|One among '''fts''' (fulltext search) and '''typeahead'''
|0...1
|fts
|-
|sort
| String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
| true
|-
|edits
|Integer
|Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|-
|partialMatch
|Boolean
|Forces a partial match search (simple search only)
| 0...1
|false
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/meetings/{id}'''

Returns the meeting associated with the given identifier.

'''/meetings/{id}/opuses'''

Returns the opuses of the meeting associated with the given identifier.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
|role
|String
|The relator code used for refining the type of contribution
|0...1
|aut
|}'''Examples'''
*[https://sit2-base-svde.atcult.it/meetings.json?q=meetings%20whose%20name%20contains%20eaton Meetings whose names contains eaton]
*[https://sit2-base-svde.atcult.it/meetings.json?q=eat&mode=typeahead Meetings typeahead search using '''eat''']
*[https://sit2-base-svde.atcult.it/meetings.json?q=iat&mode=typeahead&fuzzy=true Meetings typeahead search using '''iat''' (fuzzy match)]
*[https://sit2-base-svde.atcult.it/meetings.json?q=iat&mode=typeahead&fuzzy=false Meetings typeahead search using '''iat''' (no fuzzy)]
*[https://sit2-base-svde.atcult.it/meetings/3.json Annual J. Lloyd Eaton Conference on Science Fiction and Fantasy Literature]
==Organisation ==
A corporation or group of persons and/or organisations that acts, or may act, as a unit. It is a concrete subclass of Agent and provides a set of attributes, both datatype and object property which interconnect the entity to opuses and other bibliographic entities in the Share-VDE domain model.

'''/organisations'''

Fulltext or Typeahead search across Share-VDE organisations.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|q
|String
|An organisation query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|mode
| Enum
|One among '''fts''' (fulltext search) and '''typeahead'''
|0...1
|fts
|-
|sort
| String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
|true
|-
|edits
|Integer
|Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|-
|partialMatch
|Boolean
|Forces a partial match search (simple search only)
|0...1
|false
|-
| [[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/organisations/{id}'''

Returns the organisation associated with the given identifier.

'''/organisations/{id}/opuses'''

Returns the opuses of the organisation associated with the given identifier.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
| 0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
|role
|String
|The relator code used for refining the type of contribution
| 0...1
| aut
|}'''Examples'''
* [https://sit2-base-svde.atcult.it/organisations.json?q=organisations%20whose%20name%20doesn%27t%20contain%20xyz First 10 organisations whose name doesn't contain '''xyz''']
*[https://sit2-base-svde.atcult.it/organisations.json?q=organisations%20whose%20name%20doesn%27t%20contain%20xyz&sort=name%20desc&rows=3&offset=2 A sublist of all organisations whose name doesn't contain '''xyz''', sorted by name and paged]
*[https://sit2-base-svde.atcult.it/organisations.json?q=intern&mode=typeahead Organisations typeahead search using '''intern''']
*[https://sit2-base-svde.atcult.it/organisations.json?q=intrn&mode=typeahead&fuzzy=true Organisations typeahead search using '''intrn''' (fuzzy match)]
*[https://sit2-base-svde.atcult.it/organisations.json?q=intrn&mode=typeahead&fuzzy=false Organisations typeahead search using '''intrn''' (no fuzzy)]
*[https://sit2-base-svde.atcult.it/organisations/101.json American Library Association (ALA)]
==Family==
Two or more persons related by birth, marriage, adoption, civil union, or similar legal status, or who otherwise present themselves as a family. It is a concrete subclass of Agent and provides a set of attributes, both datatype and object property which interconnect the entity to opuses and other bibliographic entities in the Share-VDE domain model.

'''/families'''

Fulltext or Typeahead search across Share-VDE families.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
! '''Cardinality'''
!'''Default Value'''
|-
|q
|String
|A family query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]] or TermsQL (terms)
|1
|N.A.
|-
|mode
| Enum
|One among '''fts''' (fulltext search) and '''typeahead'''
|0...1
|fts
|-
|sort
| String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
| true
|-
|edits
|Integer
|Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|-
|partialMatch
|Boolean
|Forces a partial match search (simple search only)
|0...1
|false
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/families/{id}'''

Returns the family associated with the given identifier.

'''/families/{id}/opuses'''

Returns the opuses of the family associated with the given identifier.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
|role
|String
|The relator code used for refining the type of contribution
|0...1
|aut
|}'''Examples'''
*[https://sit2-base-svde.atcult.it/families.json?q=families%20whose%20name%20doesn%27t%20contain%20xyz First 10 families whose name doesn't contain '''xyz''']
*[https://sit2-base-svde.atcult.it/families.json?q=families%20whose%20name%20doesn%27t%20contain%20xyz&sort=name%20asc&rows=2&offset=2 A sublist of all families whose name doesn't contain '''xyz''', sorted by name and paged]
*[https://sit2-base-svde.atcult.it/families.json?q=famili&mode=typeahead Families typeahead search using '''emili''']
*[https://sit2-base-svde.atcult.it/families.json?q=emili&mode=typeahead&fuzzy=true Families typeahead search using '''amili''' (fuzzy match)]
*[https://sit2-base-svde.atcult.it/families.json?q=emili&mode=typeahead&fuzzy=false Families typeahead search using '''pirani''' (no fuzzy)]
==Opus==
The highest level of abstraction, a Work, in the BIBFRAME context, reflects the conceptual essence of the cataloged resource: authors, languages, and what it is about[[ShareVDEmembers:APIdoc/RESTFul API#cite%20note-%3A1-2|[2]]].

'''/opuses'''

Fulltext search across Share-VDE opuses.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|q
|String
|An opus query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]]
|1
|N.A.
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
| Integer
| A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|partialMatch
|Boolean
|Forces a partial match search (simple search only)
|0...1
|false
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
| N.A.
|}'''/opuses/{id}'''

Returns the opus associated with the given identifier.

'''/opuses/{id}/contributors'''

Returns the contributors of a given opus.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
| N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
| role
|String
|The relator code used for refining the type of contribution
|0...1
|aut
|}'''/opuses/{id}/contributors/{contributorId}'''

Returns the contributor of a given opus.

'''/opuses/{id}/publications'''

Returns the publications of a given opus.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
| 0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/opuses/{id}/publications/{publicationId}'''

Returns a specific publication of a given opus.

'''/opuses/{id}/works'''

Returns the works of a given opus.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
| String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/opuses/{id}/works/{workId}'''

Returns a specific work of a given opus.

'''/opuses/{id}/works/{workId}/instances'''

Returns the instances of a work of a given opus.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
| 0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/opuses/{id}/works/{workId}/instances/{instanceId}'''

Returns a specific work of a given opus.

'''/opuses/{id}/works/{workId}/instances/{instanceId}/items'''

Returns the items of an instance of a work of a given opus.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
| A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/opuses/{id}/works/{workId}/instances/{instanceId}/items/{itemId}'''

Returns a specific item.

'''Examples'''

Note that since the exact type of the agent cannot be known in advance, the request makes use of the ...on <type> construct.
*[https://sit2-base-svde.atcult.it/opuses.json?q=opuses%20whose%20title%20contains%20alice Opuses whose title contains alice]
*[https://sit2-base-svde.atcult.it/opuses/401.json Alice in Wonderland (Opus)]
*[https://sit2-base-svde.atcult.it/opuses/401/contributors.json Contributors of Alice in Wonderland]
*[https://sit2-base-svde.atcult.it/opuses/401/contributors.json?role=aut Authors of Alice in Wonderland]
*[https://sit2-base-svde.atcult.it/opuses/401/works.json Alice in Wonderland (Works)]
*[https://sit2-base-svde.atcult.it/opuses/401/works/401-1/instances.json Alice in Wonderland (Instances of a Work)]
* [https://sit2-base-svde.atcult.it/opuses/401/works/401-1/instances/I0001.json Alice in Wonderland (an Instance)]
*[https://sit2-base-svde.atcult.it/opuses/401/works/401-1/instances/I0001/items.json Alice in Wonderland (items of the instance above)]
*[https://sit2-base-svde.atcult.it/opuses/401/works/401-1/instances/I0001/items/501.json Alice in Wonderland (an item from the list above)]
==Work==
An intermediate level of abstraction which reflects an expression of a given Opus.

'''/works/{id}'''

Returns the work associated with the given identifier.

'''/works/{id}/contributors'''

Returns the contributors of a given work.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|-
| role
|String
|The relator code used for refining the type of contribution
|0...1
|aut
|}'''/works/{id}/contributors/{contributorId}'''

Returns the contributor of a given work.

'''/works/{workId}/instances'''

Returns the instances of a work.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
| 0...n
|N.A.
|}'''/works/{workId}/instances/{instanceId}'''

Returns a specific work.

'''/works/{workId}/instances/{instanceId}/items'''

Returns the items of an instance of a work.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
| 0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
| A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
| 0...1
|N.A.
|-
| [[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/works/{workId}/instance/{instanceId}/items/{itemId}'''

Returns a specific item.

'''Examples'''

Note that since the exact type of the agent cannot be known in advance, the request makes use of the ...on <type> construct.
*[https://sit2-base-svde.atcult.it/works/401-1/instances.json Alice in Wonderland (Instances of a Work)]
*[https://sit2-base-svde.atcult.it/works/401-1/instances/I0001.json Alice in Wonderland (an Instance)]
*[https://sit2-base-svde.atcult.it/works/401-1/instances/I0001/items.json Alice in Wonderland (items of the instance above)]
*[https://sit2-base-svde.atcult.it/works/401-1/instances/I0001/items/501.json Alice in Wonderland (an item from the list above)]
==Instance==
A Work may have one or more individual, material embodiments, for example, a particular published form. These are Instances of the Work. An Instance reflects information such as its publisher, place and date of publication, and format[[ShareVDEmembers:APIdoc/RESTFul API#cite%20note-%3A1-2|[2]]].

'''/instance/{instanceId}'''

Returns a specific instance. The Instance entity provides a connection to the bibliographic records that contributed to its definition. Specifically, when at least one of those connections is available, the instance resource representation will contain an additional set of links under the "opac" category. Each link provides the URL and the owning provenance (code). Here's an example:
{
"preferredHeading": "Lewis Carroll's Alice's adventures in Wonderland",
...
"_links": {
"self": {
"href": "<nowiki>https://svde.org/instances/I0001</nowiki>"
},
"opac": [
{
"type": "STANFORD"
"href": "<nowiki>https://searchworks.stanford.edu/view/9386906</nowiki>"
},
... (other opacs)
},
"format": {
"href": "<nowiki>https://svde.org/formats/nc</nowiki>"
},
"publicationPlace": {
"href": "<nowiki>https://svde.org/places/4930956</nowiki>"
},
"items": {
"href": "<nowiki>https://svde.org/instances/I0001/items</nowiki>"
}
}
}
'''/instances/{instanceId}/items'''

Returns the items of an instance.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|offset
|Integer
| A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
|10
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|[[ShareVDEmembers:APIdoc#Filters|filter]]
|String
|A filter clause used for refining search results
|0...n
|N.A.
|}'''/instances/{instanceId}/items/{itemId}'''

Returns a specific item.

'''Examples'''

Note that since the exact type of the agent cannot be known in advance, the request makes use of the ...on <type> construct.
*[https://sit2-base-svde.atcult.it/instances/I0001.json Alice in Wonderland (an Instance)]
*[https://sit2-base-svde.atcult.it/instances/I0001/items.json Alice in Wonderland (items of the instance above)]
*[https://sit2-base-svde.atcult.it/instances/I0001/items/501.json Alice in Wonderland (an item from the list above)]
==Item==
An item is an actual copy (physical or electronic) of an Instance. It reflects information such as its location (physical or virtual), shelf mark, and barcode[[ShareVDEmembers:APIdoc/RESTFul API#cite%20note-%3A1-2|[2]]].

'''/items/{itemId}'''

Returns a specific item.

'''Examples'''
*[https://sit2-base-svde.atcult.it/items/501.json An item, literal attributes and an object properties (availability)]
== Publication==
A publication is a logical entity which wraps together an instance (including the items) plus the parent Work. Being the instance the central entity, its local identifier is used also for denoting the corresponding publication identity (and URI)

The [https://sit2-base-svde.atcult.it/publications/I0003.json representation] is therefore very simple as it consists of the following:
{
"_links": {
"self": {
"href": "<nowiki>https://share.vde.org/publications/I0003</nowiki>"
},
"instance": {
"href": "<nowiki>https://share.vde.org/instances/I0003</nowiki>"
},
"work": {
"href": "<nowiki>https://share.vde.org/works/401-2</nowiki>"
}
}
}
/publications

Fulltext search across Share-VDE publications.
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
|q
|String
|A publication query expressed in [[ShareVDEmembers:APIdoc/Query Languages#SvdeQL|SVDEQL]]
| 1
|N.A.
|-
|sort
|String
|A valid [[ShareVDEmembers:APIdoc#Sort|sort]] clause (fts mode only)
|0...1
|N.A.
|-
|offset
|Integer
|A positive integer indicating the start offset of results (fts mode only)
|0...1
|0
|-
|rows
|Integer
|A positive integer indicating the returned page size (fts mode only)
|0...1
| 10
|-
| [[ShareVDEmembers:APIdoc#Filters|filter]]
| String
|A filter clause used for refining search results
|0...n
| N.A.
|}/publications/{id}

Returns the publication associated with the given identifier.
==Controlled Vocabulary Entities ==
Other than the entities described above, referred as "core entities", the Share-VDE domain model includes some other entities that are gathered from external sources, assigned a Share-VDE URI and linked to core entities.

 IMPORTANT: at time of writing the controlled vocabulary entities do not provide any content negotiation capability. That means the available endpoints always returns JSON according to HATEOAS specs.

 '''"format" typeahead search results:'''
"_embedded": {
"otherLanguages": [
{
"language": "fra",
"preferredHeading": "<nowiki>Bo</nowiki>bine de bande informatique",
"uri": "<nowiki>https://svde.org/formats/ch</nowiki>"
},
{
"language": "ita",
"preferredHeading": "<nowiki>Bo</nowiki>bina di nastro per computer",
"uri": "<nowiki>https://svde.org/formats/ch</nowiki>"
},
...
'''A single format'''
{
"preferredHeading": "Computer tape reel",
"comingFromSolr": true,
"_links": {
"self": [
{
"href": "<nowiki>http://id.loc.gov/vocabulary/carriers/ch</nowiki>",
"type": "other"
},
{
"href": "<nowiki>http://sit2-base-svde.atcult.it/formats/ch</nowiki>"
}
]
}
}
The list includes:
*Format
*Role
*Language
*Agent Type
* Genre
* Occupation
*Availability
*Form
*Place
*OpusType
*PublicationType
Each entity of this type provide two endpoints: a collection, which provides in turn typeahead search capabilities, and a single resource endpoint.
*[https://sit2-base-svde.atcult.it/formats?q=bo Search all formats using "bo" as search criteria]
*[https://sit2-base-svde.atcult.it/occupations?q=bo Search all occupations using "bo" as search criteria]
*[https://sit2-base-svde.atcult.it/formats/ch A format]
'''/{resourceType}'''

Typeahead search across Share-VDE controlled vocabulary entity.Note that the URI uses '''the plural form''' (e.g. /languages, /occupations, /forms)
{| class="wikitable"
|+Request Parameters
!'''Name'''
!'''Type'''
!'''Description'''
!'''Cardinality'''
!'''Default Value'''
|-
| q
|String
|A typeahead query expressed in TermsQL (terms)
|1
|N.A.
|-
|fuzzy
|Boolean
|Enables / disables the fuzzy logic (typeahead mode only)
|0...1
|true
|-
|edits
|Integer
|Max edit distance in fuzzy logic. Can be 1 or 2 (typeahead mode only)
|0...1
|1
|}'''/resourceType/{id}'''

Returns the controlled vocabulary entity associated with the given identifier. Note that the URI uses the plural form (e.g. /languages, /occupations, /forms)

<nowiki>---------------</nowiki>
#[[ShareVDEmembers:APIdoc/RESTFul API#cite%20ref-1|Jump up↑]] https://en.wikipedia.org/wiki/Representational_state_transfer
#↑ [[ShareVDEmembers:APIdoc/RESTFul API#cite%20ref-%3A1%202-0|Jump up to:2.0]] [[ShareVDEmembers:APIdoc/RESTFul API#cite%20ref-%3A1%202-1|2.1]] [[ShareVDEmembers:APIdoc/RESTFul API#cite%20ref-%3A1%202-2|2.2]] https://www.loc.gov/bibframe/docs/bibframe2-model.html

ShareDoc:Auth

2026-07-03T07:47:25Z

Massimiliano Branca:

{{DISPLAYTITLE:Share-VDE API: Authentication}}

==Overview==
Share-VDE exposes an OAuth 2.0 authentication system we call Identity Provider (IdP).

It provides both interactive and programmatic authentication, and in this document we will focus on the latter.

The IdP is hosted on the domain ip.svde.org.

The programmatic authentication is achieved through a RESTful HTTP API covering either client-based and user-based authentication use cases.

These are very similar authentication scenarios, indicating, though, different expectations.

Client authentication refers to those cases where an application needs to be authenticated in order to access common service features. This authentication guarantees the server on client’s genuinity, but no further, specific authentication is needed in this case.

On the other hand, user-based authentication binds a client authentication scenario with a specific user authentication.

Both scenarios rely on the server issuing an authentication token, used by a client to sign subsequent business requests.

Before diving into each authentication use case, let’s explore API operations.
==Roles==
The following table lists the roles defined in Share-VDE at time of writing. Endpoints are not publicly exposed, the caller is supposed to have at least a svde-reader role, which grants read permissions.
{| class="wikitable"
|+
Share-VDE Roles
!'''Name'''
!'''Code'''
!'''Description'''
|-
|Reader
|svde-reader
|Minimum level role which grants read capabilities on Share-VDE resources.
|-
|Basic Editor
|svde-editor-base
|Base editing capabilities required for the Curation API (i.e., resources editing). Includes the Reader role.
|-
|Advanced Editor
|svde-editor-advanced
|Advanced editing capabilities that allow full capabilities on Share-VDE resources. Includes the Basic Editor role.
|}
===Distinzione tra scope OAuth2 e ruoli===
Non confondere lo '''scope OAuth2''' con i '''ruoli''':
*Lo scope <code>svde-resource-read</code> è ciò che appare nel token (campo "scope" della
risposta di autenticazione). Garantisce l'accesso autenticato alle API.*Il ruolo <code>svde-editor-base</code> è un '''ruolo client Keycloak''' (non uno scope OAuth2).
Nella pratica, un token con scope <code>svde-resource-read</code> ma senza ruolo editor
accede a tutte le API di lettura '''eccetto''' le ricerche root <code>/works</code>,
<code>/instances</code>, <code>/items</code>, <code>/dates</code> (che richiedono
<code>svde-editor-base</code>).
Per un'integrazione di sola lettura non serve alcun ruolo editor.
==API operations==

===Obtain a new authentication token===
The first request a client must make to authenticate with ShareVDE is the /token request.

In case of client authentication, you will need client credentials, i.e. a Client ID and a Client Secret issued by Share-VDE.

In case of user authentication, you will need client credentials as well as a username and password.

The request returns a JSON structure containing a new authentication token to be used in subsequent operations.

====Request endpoint====
{| class="cuscosky"
!HTTP Method
!Endpoint
|-
|POST
|/auth/realms/ShareVDE/protocol/openid-connect/token
|}

====Authorization header====
Authorization: Basic <authorization hash>
Here the Client ID and Client Secret issued by Share-VDE come into play.

The authorization hash is computed as follows:
Base64(client_id + “:” + client_secret)
This header must always be present for token requests, regardless of the client or user authentication use case.

====Content-Type header====
Content-Type: application/x-www-form-urlencoded

====Request body====
{| class="cuscosky" style="width:100%;"
!Key
!Description
!Value
(Client auth)
!Value (User auth)
|-
|grant_type
|The kind of grant operation that is going to be requested to the server
|client_credentials
|password
|-
|username
|The user id to authenticate
|Not applicable
|<Provided by the user>
|-
|password
|The password to use
|Not applicable
|<Provided by the user>
|}

====Example - Client authentication request====
<syntaxhighlight lang="shell">
curl --location --request POST 'https://sit3-ip-base-svde.atcult.it/auth/realms/ShareVDE/protocol/openid-connect/token' \
--header 'Authorization: Basic c2hhcmV2ZGUtYXBpLWdhdGV3YXk6MDU3NzlmYzItNzI5Yy00NmYyLTg2YWYtMTIzNTJkYTY5MmU2' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=sharevde-api-gateway' \
--data-urlencode 'client_secret=a_valid_secret' \
--data-urlencode 'grant_type=client_credentials'
</syntaxhighlight>

====Example - User authentication request====
curl --location --request POST \
'<nowiki>https://ip.share-vde.org/auth/realms/ShareVDE/protocol/openid-connect/token'</nowiki> \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Referer: <nowiki>https://af4080f8fb8a.ngrok.io/'</nowiki> \
--header 'Authorization: Basic \
c2hhcmV2ZGUtYXBpLWdhdGV3YXk6MDU3NzlmYzItNzI5Yy00NmYyLTg2YWYtMTIzNTJkYTY5MmU2' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=a_valid_user' \
--data-urlencode 'password=a_valid_password'

====Example - Authentication response====
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ...",
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token": ”eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6IC...",
"token_type": "bearer",
"not-before-policy": 0,
"session_state": "acb9a64f-5309-4536-9fb2-682fe48fd58d",
"scope": "email profile svde-resource-read"
}
Regardless of the client or user authentication scenario, the successful authentication response has the same structure. Let’s analyze its contents:

*<code>access_token</code>: the token to be used to sign subsequent business REST requests (see the example later in this document). It is digitally signed by the Share-VDE realm.

*<code>expires_in</code>: the token’s TTL (in seconds). After this number of seconds has passed since token emission, the token won’t be valid anymore, unless a refresh request is issued by the client.

*<code>refresh_expires_in</code>: the refresh token’s TTL. It represents indeed the time window (in seconds) within which the client can request the server-side session’s TTL extension. The new session’s TTL will be equal to the amount of seconds expressed with the expires_in member. After the number of seconds expressed by this member has passed, the session won’t be usable anymore.
*<code>refresh_token</code>: the token to be used to sign the next refresh request (see the example later in this document).
*token_type: the type of the issued token; for Share-VDE it will be “bearer”, meaning the token must be used in a “Authorization: Bearer” header.
*<code>not-before-policy</code>: a time-based revocation policy. The server allows administrators to specify a time and date where any session or token issued before that time and date is invalid. For Share-VDE such value will always be zero (i.e. the token is valid starting from the exact moment it is issued).
*<code>session_state</code>: the session state id. By definition, a session is a continuous period of time during which an end-user or an application accesses a Relying Party relying on the authentication of the end-user performed by the Identity Provider.
*<code>scope</code>: a space-separated list of strings, showing the scopes represented by the access_token.

===Refresh an authentication token===
Via the <code>/token</code> request it is possible to request a new access token maintaining the same <code>session_status</code>.

This objective is achieved with the use of the <code>refresh_token</code> operation type (a.k.a grant type).

It is important to point out that access tokens have a usually short TTL and they often expire after only minutes. The additional refresh token that was transmitted by the <code>client_credentials</code> or <code>password</code> operations has a longer TTL and allows the client to obtain a new access token after it expires, maintaining the same session of the original scope.

With short-lived access tokens, things are made more secure and more scalable for the whole system.

====Request endpoint====
{| class="cuscosky"
!HTTP Method
!Endpoint
|-
|POST
|/auth/realms/ShareVDE/protocol/openid-connect/token
|}

====Authorization header====
Authorization: Basic <authorization hash>
The authorization hash is computed as follows:
Base64(client_id + “:” + client_secret)

====Content-Type header====
Content-Type: application/x-www-form-urlencoded

====Request body====
{| class="cuscosky" style="width:100%;"
!Key
!Description
!Value (client auth)
!Value (user auth)
|-
|grant_type
|The kind of grant operation that is going to be requested to the server
|refresh_token
|refresh_token
|-
|username
|The user id to authenticate
|Not applicable
|<Provided by the user>
|-
|password
|The password to use
|Not applicable
|<Provided by the user>
|-
|client_id
|The client id used in the Authorization header
|<client_id>
|<client_id>
|-
|client_secret
|The client secret used in the Authorization header
|<client secret>
|<client secret>
|-
|refresh_token
|The refresh_token value received with the previous “new token” or “refresh token” response
|<taken from the previous request>
|<taken from the previous request>
|}

====Example - Client refresh token====
curl --location --request POST '<nowiki>https://ip.svde.org/auth/realms/ShareVDE/protocol/openid-connect/token'</nowiki> \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id=my-app-id' \
--data-urlencode 'client_secret=a_valid_client_secret' \
--data-urlencode 'refresh_token=eyJhbGciOiJIUzI1NiIsInR5cCIgOiA...'

====Example - User refresh token====
curl --location --request POST 'https://idp<nowiki/>.svde.org/auth/realms/ShareVDE/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'client_id=my-app-id' \
--data-urlencode 'client_secret=a_valid_client_secret' \
--data-urlencode 'username=a_valid_username' \
--data-urlencode 'password=a_valid_password' \
--data-urlencode 'refresh_token=eyJhbGciOiJIUzI1NiIsInR5cCIgOiA...'

====Example - Refresh response====
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICz...",
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token": ”eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwiaAkzmjsHdu...",
"token_type": "bearer",
"not-before-policy": 0,
"session_state": "acb9a64f-5309-4536-9fb2-682fe48fd58d",
"scope": "email profile svde-resource-read"
}
The successful refresh token response has the same structure as the new token response. Refer to that section for a description of each field.

===Example of a business request===
The general principle is that both GraphQL API and REST api are protected by Share-VDE’s IdP.

We must use received access tokens to sign every request towards those two interfaces.

Let’s see how to perform a request towards the <code>/api/graphql</code> endpoint.
{| class="cuscosky" style="width:100%;"
|<big>ℹ</big>
|NOTE: Until the definitive Share-VDE environment will be available, instead of api.svde.org please use beta-base.svde.org.
|}
curl --location --request POST '<nowiki>https://api.svde.org/api/graphql'</nowiki> \
--header 'Authorization: Bearer eyJhbGcIgOiAiSldUIiwia2lkIiA6ICJ5eDZhRjZtM3ZTZkdIO...' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"{\n person(uri: \"<nowiki>https://share-vde.org/agents/201631288953646</nowiki>\") {\n uri\n preferredHeading\n occupations {\n uri\n language\n preferredHeading\n alternateHeadings\n }\n }\n}","variables":null,"operationName":null}'

==Error responses==
In case of errors, the Share-VDE’s authentication RESTful API responds with the following HTTP status codes:
{| class="cuscosky"
|400
|Malformed request. The request is incomplete or the payload is malformed.
|-
|401
|Unauthorized. The authentication is possible but has failed or has not been provided yet.
|-
|403
|Forbidden. The resource is available, but the authorization level is not sufficient in order to access it.
|}