Interpol: Interpol Red Notices API
Project description
interpol
Interpol Red Notices Website API
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python >= 3.6
Installation & Usage
pip install
pip install deutschland[interpol]
poetry install
poetry add deutschland -E interpol
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Usage
Import the package:
from deutschland import interpol
Getting Started
Please follow the installation procedure and then run the following:
import time
from deutschland import interpol
from pprint import pprint
from deutschland.interpol.api import default_api
from deutschland.interpol.model.red_notice_detail import RedNoticeDetail
from deutschland.interpol.model.red_notice_detail_images import RedNoticeDetailImages
from deutschland.interpol.model.red_notices import RedNotices
# Defining the host is optional and defaults to https://ws-public.interpol.int
# See configuration.py for a list of all supported configuration parameters.
configuration = interpol.Configuration(
host = "https://ws-public.interpol.int"
)
# Enter a context with an instance of the API client
with interpol.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
forename = "DANIELA" # str | First name (optional)
name = "Klette" # str | Last name (optional)
nationality = "DE" # str | Two digit country code (optional)
age_max = 120 # int | maximum age (optional)
age_min = 18 # int | minimum age (optional)
free_text = "" # str | Free text query (optional)
sex_id = "F" # str | Free text query (optional)
arrest_warrant_country_id = "DE" # str | Two digit country code (optional)
page = 1 # int | pagination - starts with 1 (optional)
result_per_page = 200 # int | resultPerPage (optional)
try:
# Get Red Notices
api_response = api_instance.notices_v1_red_get(forename=forename, name=name, nationality=nationality, age_max=age_max, age_min=age_min, free_text=free_text, sex_id=sex_id, arrest_warrant_country_id=arrest_warrant_country_id, page=page, result_per_page=result_per_page)
pprint(api_response)
except interpol.ApiException as e:
print("Exception when calling DefaultApi->notices_v1_red_get: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://ws-public.interpol.int
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | notices_v1_red_get | GET /notices/v1/red | Get Red Notices |
DefaultApi | notices_v1_red_notice_id_get | GET /notices/v1/red/{noticeID} | Get Red Notice Details |
DefaultApi | notices_v1_red_notice_id_images_get | GET /notices/v1/red/{noticeID}/images | Get Red Notice Images |
Documentation For Models
- RedNoticeDetail
- RedNoticeDetailArrestWarrants
- RedNoticeDetailEmbedded
- RedNoticeDetailImages
- RedNoticeDetailImagesEmbedded
- RedNoticeDetailImagesEmbeddedImages
- RedNoticeDetailImagesEmbeddedLinks
- RedNoticeDetailImagesEmbeddedLinksSelf
- RedNoticeDetailImagesLinks
- RedNoticeDetailImagesLinksNotice
- RedNoticeDetailImagesLinksSelf
- RedNoticeDetailImagesLinksThumbnail
- RedNoticeDetailLinks
- RedNotices
- RedNoticesEmbedded
- RedNoticesLinks
- RedNoticesLinksSelf
- RedNoticesQuery
Documentation For Authorization
All endpoints do not require authorization.
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in interpol.apis and interpol.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from deutschland.interpol.api.default_api import DefaultApi
from deutschland.interpol.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
from deutschland import interpol
from deutschland.interpol.apis import *
from deutschland.interpol.models import *
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for de_interpol-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da62322462c5c841ff0ec27191bcd531af6e50c1d096e3bacfd40423cb6e1da2 |
|
MD5 | bd732cdba8269a4cf870dac3aa402b86 |
|
BLAKE2b-256 | 89864a4d80a63e152e7e7604948b6b44f230674a7f0f4f4c7f5c006911561f08 |