<h1>django_api package<a class="headerlink" href="#django-api-package" title="Permalink to this headline"></a></h1>
<p>The django_api package implements the admin backend and web service components of the OACCT application.
It uses the Django REST framework <a class="reference external" href="https://www.django-rest-framework.org/">https://www.django-rest-framework.org/</a> and the standard Django admin site.</p>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-django_api.admin">
<span id="django-api-admin-module"></span><h2>django_api.admin module<a class="headerlink" href="#module-django_api.admin" title="Permalink to this headline"></a></h2>
<p>Django admin module for the django_api application</p>
<p>All admin pages inherit from import_export.admin.ImportExportModelAdmin for JSON import/export</p>
<span class="sig-name descname"><span class="pre">form</span></span><a class="headerlink" href="#django_api.admin.ConditionSetAdmin.form" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.admin.ConditionSetAdminForm.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.admin.IssnInline.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">formset</span></span><a class="headerlink" href="#django_api.admin.JournalConditionInline.formset" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>def connect_all_journals(self, request, obj, parent_obj=None):</dt><dd><p># Do stuff here, then return None to go to current view
return None</p>
</dd>
</dl>
<p>connect_all_journals.short_description = (“Connect Condition Set with some or all Journals”)</p>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.admin.JournalConditionInline.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">formset</span></span><a class="headerlink" href="#django_api.admin.OrganizationConditionInline.formset" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.admin.OrganizationConditionInline.model" title="Permalink to this definition"></a></dt>
<dd><p>Action to set the start date for selected Journal-Condition relationships.
This action was introduced to add validity dates to batch-uploaded JournalConditions that lacked this information.</p>
</dd></dl>
</section>
<section id="module-django_api.apps">
<span id="django-api-apps-module"></span><h2>django_api.apps module<a class="headerlink" href="#module-django_api.apps" title="Permalink to this headline"></a></h2>
<span class="sig-name descname"><span class="pre">verbose_name</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'OACCT</span> <span class="pre">back-end'</span></em><a class="headerlink" href="#django_api.apps.DjangoApiConfig.verbose_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-django_api.models">
<span id="django-api-models-module"></span><h2>django_api.models module<a class="headerlink" href="#module-django_api.models" title="Permalink to this headline"></a></h2>
<p>Django object models for the django_api application of the OACCT project.</p>
<p>Condition sets: collections of Open Access terms applicable to zero or more Journals and zero or more Organizations
for some specific reason (policy document, agreement, contract…).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>condition_type</strong> (reference to a <cite>ConditionType</cite> object) – type for the condition set</p></li>
<li><p><strong>subtype</strong> (eference to a <cite>ConditionSubType</cite> object) – subtype for the condition set</p></li>
<li><p><strong>organization</strong> (many-to-many relationship with the <cite>Organization</cite> class with <cite>OrganizationCondition</cite> objects as connectors) – zero or more organisations to which the condition set is applicable</p></li>
<li><p><strong>journal</strong> (many-to-many relationship with the <cite>Journal</cite> class with <cite>JournalCondition</cite> objects as connectors) – zero or more journals to which the condition set is applicable</p></li>
<li><p><strong>term</strong> (many-to-many relationship with the <cite>Term</cite> class) – zero or more terms included in the condition set</p></li>
<li><p><strong>source</strong> (<em>URL</em><em>, </em><em>optional</em>) – web page with information about the condition set (origin, perimeter, etc.)</p></li>
<li><p><strong>comment</strong> (<em>str</em><em>, </em><em>optional</em>) – description of the condition set as free text (will be used as a title in the frontend)</p></li>
<span class="sig-name descname"><span class="pre">comment</span></span><a class="headerlink" href="#django_api.models.ConditionSet.comment" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">condition_type</span></span><a class="headerlink" href="#django_api.models.ConditionSet.condition_type" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">condition_type_id</span></span><a class="headerlink" href="#django_api.models.ConditionSet.condition_type_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.ConditionSet.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journal</span></span><a class="headerlink" href="#django_api.models.ConditionSet.journal" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">journalcondition_set</span></span><a class="headerlink" href="#django_api.models.ConditionSet.journalcondition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">organization</span></span><a class="headerlink" href="#django_api.models.ConditionSet.organization" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">organizationcondition_set</span></span><a class="headerlink" href="#django_api.models.ConditionSet.organizationcondition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">source</span></span><a class="headerlink" href="#django_api.models.ConditionSet.source" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">subtype</span></span><a class="headerlink" href="#django_api.models.ConditionSet.subtype" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">subtype_id</span></span><a class="headerlink" href="#django_api.models.ConditionSet.subtype_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">term</span></span><a class="headerlink" href="#django_api.models.ConditionSet.term" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">conditionset_set</span></span><a class="headerlink" href="#django_api.models.ConditionSubType.conditionset_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.ConditionSubType.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">label</span></span><a class="headerlink" href="#django_api.models.ConditionSubType.label" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">condition_issuer</span></span><a class="headerlink" href="#django_api.models.ConditionType.condition_issuer" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">conditionset_set</span></span><a class="headerlink" href="#django_api.models.ConditionType.conditionset_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.ConditionType.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">amount</span></span><a class="headerlink" href="#django_api.models.Cost_factor.amount" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">comment</span></span><a class="headerlink" href="#django_api.models.Cost_factor.comment" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">cost_factor_type</span></span><a class="headerlink" href="#django_api.models.Cost_factor.cost_factor_type" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">cost_factor_type_id</span></span><a class="headerlink" href="#django_api.models.Cost_factor.cost_factor_type_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Cost_factor.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">symbol</span></span><a class="headerlink" href="#django_api.models.Cost_factor.symbol" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">term_set</span></span><a class="headerlink" href="#django_api.models.Cost_factor.term_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">cost_factor_set</span></span><a class="headerlink" href="#django_api.models.Cost_factor_type.cost_factor_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Cost_factor_type.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Cost_factor_type.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Country.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">iso_code</span></span><a class="headerlink" href="#django_api.models.Country.iso_code" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Country.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">organization_set</span></span><a class="headerlink" href="#django_api.models.Country.organization_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">publisher_set</span></span><a class="headerlink" href="#django_api.models.Country.publisher_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Issn.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">issn</span></span><a class="headerlink" href="#django_api.models.Issn.issn" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">issn_type</span></span><a class="headerlink" href="#django_api.models.Issn.issn_type" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journal</span></span><a class="headerlink" href="#django_api.models.Issn.journal" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">journal_id</span></span><a class="headerlink" href="#django_api.models.Issn.journal_id" title="Permalink to this definition"></a></dt>
<li><p><strong>name_short_iso_4</strong> (<em>str</em>) – ISO 4 abbreviation of the title</p></li>
<li><p><strong>publisher</strong> (many-to-many relationshio with class <cite>Publisher</cite>) – zero or more publishers in charge of the Journal</p></li>
<li><p><strong>website</strong> (<em>URL</em>) – home page of the journal</p></li>
<li><p><strong>language</strong> (many-to-many relationship with class <cite>Journal</cite>) – the journal publishes articles in these zero or more languages</p></li>
<li><p><strong>oa_options</strong> (<em>URL</em><em>, </em><em>optional</em>) – web page with the journal’s Open Access conditions</p></li>
<li><p><strong>oa_status</strong> (reference to an <cite>Oa</cite> object) – Open Access status</p></li>
<li><p><strong>end_year</strong> – end year if applicable</p></li>
<li><p><strong>doaj_seal</strong> (<em>bool</em>) – did the journal obtain the DOAJ Seal? <a class="reference external" href="https://doaj.org/apply/seal/">https://doaj.org/apply/seal/</a></p></li>
<li><p><strong>doaj_status</strong> (<em>bool</em>) – is the journal accepted in the Directory of Open Access Journals? <a class="reference external" href="https://doaj.org">https://doaj.org</a></p></li>
<li><p><strong>lockss</strong> (<em>bool</em>) – is the journal archived by LOCKSS? <a class="reference external" href="https://www.lockss.org/about">https://www.lockss.org/about</a></p></li>
<li><p><strong>nlch</strong> (<em>bool</em>) – please remind me what this is supposed to be</p></li>
<li><p><strong>portico</strong> (is the journal archived by Portico? <a class="reference external" href="https://www.portico.org/">https://www.portico.org/</a>) – did the journal obtain the DOAJ Seal? <a class="reference external" href="https://doaj.org/apply/seal/">https://doaj.org/apply/seal/</a></p></li>
<span class="sig-name descname"><span class="pre">classIssn</span></span><a class="headerlink" href="#django_api.models.Journal.classIssn" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">conditionset_set</span></span><a class="headerlink" href="#django_api.models.Journal.conditionset_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">doaj_seal</span></span><a class="headerlink" href="#django_api.models.Journal.doaj_seal" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">doaj_status</span></span><a class="headerlink" href="#django_api.models.Journal.doaj_status" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">end_year</span></span><a class="headerlink" href="#django_api.models.Journal.end_year" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Journal.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journalcondition_set</span></span><a class="headerlink" href="#django_api.models.Journal.journalcondition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">language</span></span><a class="headerlink" href="#django_api.models.Journal.language" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">lockss</span></span><a class="headerlink" href="#django_api.models.Journal.lockss" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Journal.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name_short_iso_4</span></span><a class="headerlink" href="#django_api.models.Journal.name_short_iso_4" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">nlch</span></span><a class="headerlink" href="#django_api.models.Journal.nlch" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">oa_options</span></span><a class="headerlink" href="#django_api.models.Journal.oa_options" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">oa_status</span></span><a class="headerlink" href="#django_api.models.Journal.oa_status" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">oa_status_id</span></span><a class="headerlink" href="#django_api.models.Journal.oa_status_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">portico</span></span><a class="headerlink" href="#django_api.models.Journal.portico" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">publisher</span></span><a class="headerlink" href="#django_api.models.Journal.publisher" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">qoam_av_score</span></span><a class="headerlink" href="#django_api.models.Journal.qoam_av_score" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">starting_year</span></span><a class="headerlink" href="#django_api.models.Journal.starting_year" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">website</span></span><a class="headerlink" href="#django_api.models.Journal.website" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">condition_set</span></span><a class="headerlink" href="#django_api.models.JournalCondition.condition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">condition_set_id</span></span><a class="headerlink" href="#django_api.models.JournalCondition.condition_set_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.JournalCondition.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journal</span></span><a class="headerlink" href="#django_api.models.JournalCondition.journal" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">journal_id</span></span><a class="headerlink" href="#django_api.models.JournalCondition.journal_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">valid_from</span></span><a class="headerlink" href="#django_api.models.JournalCondition.valid_from" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">valid_until</span></span><a class="headerlink" href="#django_api.models.JournalCondition.valid_until" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Language.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">iso_code</span></span><a class="headerlink" href="#django_api.models.Language.iso_code" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journal_set</span></span><a class="headerlink" href="#django_api.models.Language.journal_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Language.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Licence.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name_or_abbrev</span></span><a class="headerlink" href="#django_api.models.Licence.name_or_abbrev" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">term_set</span></span><a class="headerlink" href="#django_api.models.Licence.term_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">website</span></span><a class="headerlink" href="#django_api.models.Licence.website" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<p>Open Access status: used as attribute by Journals</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>status</strong> (<em>str</em><em>, </em><em>optional</em>) – short name, ideally one word i.e. Green, Gold, UNKNOWN…</p></li>
<li><p><strong>description</strong> – description text up to 1000 characters</p></li>
<li><p><strong>subscription</strong> (<em>bool</em>) – does a journal with this status require a subscription?</p></li>
<li><p><strong>accepted_manuscript</strong> (<em>bool</em>) – does a journal with this status generally allow to distribute the accepted manuscript?</p></li>
<li><p><strong>apc</strong> (<em>bool</em>) – does a journal with this status require Article Processing Charges (APCs)?</p></li>
<li><p><strong>final_version</strong> (<em>bool</em>) – does a journal with this status generally allow to distribute the published version?</p></li>
<span class="sig-name descname"><span class="pre">accepted_manuscript</span></span><a class="headerlink" href="#django_api.models.Oa.accepted_manuscript" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">apc</span></span><a class="headerlink" href="#django_api.models.Oa.apc" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#django_api.models.Oa.description" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">final_version</span></span><a class="headerlink" href="#django_api.models.Oa.final_version" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Oa.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">oa_status</span></span><a class="headerlink" href="#django_api.models.Oa.oa_status" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">status</span></span><a class="headerlink" href="#django_api.models.Oa.status" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">subscription</span></span><a class="headerlink" href="#django_api.models.Oa.subscription" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<p>Organizations: one of the big entities in the application, organizations (research institutions or funders) who employ or fund the authors/researchers</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) – name of the organization</p></li>
<li><p><strong>website</strong> (<em>URL</em><em>, </em><em>optional</em>) – web site of the organization</p></li>
<li><p><strong>country</strong> (many-to-many relationship with class <cite>Country</cite>) – zero or more home countries</p></li>
<li><p><strong>is_funder</strong> (<em>bool</em>) – if True, the organization is a funding agency, if False a research organization</p></li>
<li><p><strong>ir_name</strong> (<em>URL</em><em>, </em><em>optional</em>) – name of the oeganization’s institutional repository for publications, if applicable</p></li>
<li><p><strong>ir_url</strong> – address of the oeganization’s institutional repository for publications, if applicable</p></li>
<span class="sig-name descname"><span class="pre">conditionset_set</span></span><a class="headerlink" href="#django_api.models.Organization.conditionset_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">country</span></span><a class="headerlink" href="#django_api.models.Organization.country" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">fundref</span></span><a class="headerlink" href="#django_api.models.Organization.fundref" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Organization.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">ir_name</span></span><a class="headerlink" href="#django_api.models.Organization.ir_name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">ir_url</span></span><a class="headerlink" href="#django_api.models.Organization.ir_url" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">is_funder</span></span><a class="headerlink" href="#django_api.models.Organization.is_funder" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Organization.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">organizationcondition_set</span></span><a class="headerlink" href="#django_api.models.Organization.organizationcondition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the reverse side of a
<span class="sig-name descname"><span class="pre">ror</span></span><a class="headerlink" href="#django_api.models.Organization.ror" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">starting_year</span></span><a class="headerlink" href="#django_api.models.Organization.starting_year" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">website</span></span><a class="headerlink" href="#django_api.models.Organization.website" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">condition_set</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.condition_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">condition_set_id</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.condition_set_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">organization</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.organization" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related object on the forward side of a many-to-one or
<span class="sig-name descname"><span class="pre">organization_id</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.organization_id" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">valid_from</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.valid_from" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">valid_until</span></span><a class="headerlink" href="#django_api.models.OrganizationCondition.valid_until" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">city</span></span><a class="headerlink" href="#django_api.models.Publisher.city" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">country</span></span><a class="headerlink" href="#django_api.models.Publisher.country" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Publisher.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">journal_set</span></span><a class="headerlink" href="#django_api.models.Publisher.journal_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#django_api.models.Publisher.name" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">oa_policies</span></span><a class="headerlink" href="#django_api.models.Publisher.oa_policies" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">starting_year</span></span><a class="headerlink" href="#django_api.models.Publisher.starting_year" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">state</span></span><a class="headerlink" href="#django_api.models.Publisher.state" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">website</span></span><a class="headerlink" href="#django_api.models.Publisher.website" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<p>Terms: possible options to disseminate an article in Open Access</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>version</strong> (many-to-many relationship to the <cite>Version</cite> class) – zero or more versions for which the Term is applicable (currently only 1 is supported by the application)</p></li>
<li><p><strong>cost_factor</strong> (many-to-many relationship to the <cite>Cost_factor</cite> class) – zero or more possible cost factors</p></li>
<li><p><strong>licence</strong> (many-to-many relationship to the <cite>Licence</cite> class) – zero or more possible licenses</p></li>
<li><p><strong>embargo_months</strong> (<em>int</em>) – duration of a possible embargo in months</p></li>
<li><p><strong>ir_archiving</strong> (<em>bool</em>) – is archiving in an institutional repository allowed/required or not?</p></li>
<li><p><strong>comment</strong> (<em>str</em><em>, </em><em>optional</em>) – extra information as free text</p></li>
<span class="sig-name descname"><span class="pre">comment</span></span><a class="headerlink" href="#django_api.models.Term.comment" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">conditionset_set</span></span><a class="headerlink" href="#django_api.models.Term.conditionset_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">cost_factor</span></span><a class="headerlink" href="#django_api.models.Term.cost_factor" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">embargo_months</span></span><a class="headerlink" href="#django_api.models.Term.embargo_months" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Term.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">ir_archiving</span></span><a class="headerlink" href="#django_api.models.Term.ir_archiving" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">licence</span></span><a class="headerlink" href="#django_api.models.Term.licence" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#django_api.models.Term.version" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#django_api.models.Version.description" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">id</span></span><a class="headerlink" href="#django_api.models.Version.id" title="Permalink to this definition"></a></dt>
<dd><p>A wrapper for a deferred-loading field. When the value is read from this
<span class="sig-name descname"><span class="pre">term_set</span></span><a class="headerlink" href="#django_api.models.Version.term_set" title="Permalink to this definition"></a></dt>
<dd><p>Accessor to the related objects manager on the forward and reverse sides of
<p><code class="docutils literal notranslate"><span class="pre">Pizza.toppings</span></code> and <code class="docutils literal notranslate"><span class="pre">Topping.pizzas</span></code> are <code class="docutils literal notranslate"><span class="pre">ManyToManyDescriptor</span></code>
instances.</p>
<p>Most of the implementation is delegated to a dynamically defined manager
class built by <code class="docutils literal notranslate"><span class="pre">create_forward_many_to_many_manager()</span></code> defined below.</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-django_api.serializers">
<span id="django-api-serializers-module"></span><h2>django_api.serializers module<a class="headerlink" href="#module-django_api.serializers" title="Permalink to this headline"></a></h2>
<p>REST API serializers</p>
<p>All serializers inherit from WritableNestedModelSerializer to allow writing nested objects
through the API as per <a class="reference external" href="https://github.com/beda-software/drf-writable-nested">https://github.com/beda-software/drf-writable-nested</a>
and RQLMixin to support the Resource Query Language (RQL) <a class="reference external" href="https://django-rql.readthedocs.io/en/latest/">https://django-rql.readthedocs.io/en/latest/</a></p>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.ConditionSetLightSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.ConditionSetSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.ConditionSubTypeSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.ConditionTypeSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.Cost_factorSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.Cost_factor_typeSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.CountrySerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.IssnSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.JournalConditionSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.JournalIdSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.JournalLightSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.JournalSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.LanguageSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.LicenceSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.OaSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.OrgaSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.OrganizationConditionSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.PublisherSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.TermSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#django_api.serializers.VersionSerializer.Meta.model" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">description</span></span><em class="property"> <span class="pre">=</span> <span class="pre"><django.db.models.fields.CharField></span></em><a class="headerlink" href="#django_api.serializers.VersionSerializer.description" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-django_api.tests">
<span id="django-api-tests-module"></span><h2>django_api.tests module<a class="headerlink" href="#module-django_api.tests" title="Permalink to this headline"></a></h2>
</section>
<section id="module-django_api.urls">
<span id="django-api-urls-module"></span><h2>django_api.urls module<a class="headerlink" href="#module-django_api.urls" title="Permalink to this headline"></a></h2>
</section>
<section id="module-django_api.views">
<span id="django-api-views-module"></span><h2>django_api.views module<a class="headerlink" href="#module-django_api.views" title="Permalink to this headline"></a></h2>
<span class="sig-name descname"><span class="pre">MODEL</span></span><a class="headerlink" href="#django_api.views.ConditionSetFilters.MODEL" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">rql_filter_class</span></span><a class="headerlink" href="#django_api.views.ConditionSetLightViewSet.rql_filter_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.ConditionSetLightViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">rql_filter_class</span></span><a class="headerlink" href="#django_api.views.ConditionSetViewSet.rql_filter_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.ConditionSetViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.ConditionTypeViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.Cost_factorViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.Cost_factor_typeViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.CountryViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.FunderViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.IssnViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.JournalConditionViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.JournalLightViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.JournalViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.LanguageViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.LicenceViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.OaViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.OrgaViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.OrganizationConditionViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.PublisherViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.TermViewSet.serializer_class" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">serializer_class</span></span><a class="headerlink" href="#django_api.views.VersionViewSet.serializer_class" title="Permalink to this definition"></a></dt>