GETTING STARTED

Available endpoints

  • /organisms/ > list all organisms

  • /organisms/<int:pk> > retrieve one organism by organism id

  • /organisms/<int:pk>/members > retrieve one organism members by organism id

Dependencies

  • Django Rest Framework

Installation

pip install -U dj-sinp-organisms

Configuration

Configure INSTALLED_APPS:

INSTALLED_APPS = (
    'django.contrib.admin',
    'django.contrib.auth',
    (...),
    'rest_framework',
    'sinp_nomenclatures',
    'sinp_organisms',
    (...),
)

Configure urls.py:

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api-auth/', include('rest_framework.urls')),
    (...),
    path('api/v1/', include('sinp_nomenclatures.urls')),
    path('api/v1/', include('sinp_organisms.urls')),
    (...),
]

Models

Database model