sysnet-persons 1.0.4.2

SYSNET Persons Registry REST API client

persons

This is a API to Persons Registry

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.4
• Package version: 1.0.4.002
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install sysnet-persons

Then import the package:

import persons 

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import persons
from persons.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
name = 'name_example' # str | Název tagu

try:
    # odstraní definici tagu  (cruD)
    api_response = api_instance.delete_tag(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->delete_tag: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))

try:
    # získá konfiguraci konektoru
    api_response = api_instance.get_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->get_config: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
name = 'name_example' # str | Název tagu

try:
    # vrací definici tagu (cRud)
    api_response = api_instance.get_tag(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->get_tag: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
tag = 'tag_example' # str | Vyhledání podle tagu (optional)
search = 'search_example' # str | Textové vyhledávání (optional)
start = 56 # int | První dokument na stránce (optional)
page_size = 56 # int | Velikost stránky při stránkovaném výstupu (optional)
page = 56 # int | Číslo stránky výstupu (optional)

try:
    # vrací seznam tagů v systému (autocomplete)
    api_response = api_instance.get_tag_list(tag=tag, search=search, start=start, page_size=page_size, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->get_tag_list: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
body = persons.TagItemType() # TagItemType |  (optional)

try:
    # vytvoří nový tag (Crud)
    api_response = api_instance.post_tag(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->post_tag: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
body = NULL # object |  (optional)

try:
    # aktualizuje hlavní konfiguraci konektoru
    api_response = api_instance.put_config(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->put_config: %s\n" % e)

# Configure API key authorization: apiKey
configuration = persons.Configuration()
configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'

# create an instance of the API class
api_instance = persons.AdminsApi(persons.ApiClient(configuration))
name = 'name_example' # str | Název tagu
body = persons.TagItemType() # TagItemType |  (optional)

try:
    # aktualizuje definici tagu (crUd)
    api_response = api_instance.put_tag(name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->put_tag: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://service.sysnet.cz/persons/1.0.4

Class	Method	HTTP request	Description
AdminsApi	delete_tag	DELETE /tag/{name}	odstraní definici tagu (cruD)
AdminsApi	get_config	GET /config	získá konfiguraci konektoru
AdminsApi	get_tag	GET /tag/{name}	vrací definici tagu (cRud)
AdminsApi	get_tag_list	GET /tag	vrací seznam tagů v systému (autocomplete)
AdminsApi	post_tag	POST /tag	vytvoří nový tag (Crud)
AdminsApi	put_config	PUT /config	aktualizuje hlavní konfiguraci konektoru
AdminsApi	put_tag	PUT /tag/{name}	aktualizuje definici tagu (crUd)
CrzpApi	delete_crzp_person	DELETE /crzp/person/{crzp_id}	Odstraní CRŽP uuid z osoby
CrzpApi	get_crzp_person	GET /crzp/person/{crzp_id}	Vrátí subjekt podle CRŽP uuid
CrzpApi	get_crzp_person_list	GET /crzp/person	Vrátí subjekty s vazbou do CRŽP
CrzpApi	post_crzp_person	POST /crzp/person/{crzp_id}	Přiřadí CRŽP uuid osobě
CrzpApi	put_crzp_person	PUT /crzp/person/{crzp_id}	Přiřadí CRŽP uuid osobě
DevelopersApi	info_api	GET /info	vrací servisní informace
DevelopersApi	info_api_head	HEAD /info	vrací informaci o dostupnosti služby
LinkApi	delete_individual_role	DELETE /individual/role/{individual_id}	Odebere roli uživateli
LinkApi	delete_person_member	DELETE /person/member/{person_id}	Odebere člena osobě
LinkApi	delete_person_role	DELETE /person/role/{person_id}	Odebere roli osobě
LinkApi	get_individual_roles	GET /individual/role/{individual_id}	Získá všechny role pro uživatele
LinkApi	get_person_members	GET /person/member/{person_id}	Získá všechny uživatele pro osobu
LinkApi	get_person_roles	GET /person/role/{person_id}	Získá všechny role pro osobu
LinkApi	put_individual_role	PUT /individual/role/{individual_id}	Přiřadí uživateli roli
LinkApi	put_person_member	PUT /person/member/{person_id}	Přiřadí uživatela za člena osoby
LinkApi	put_person_role	PUT /person/role/{person_id}	Přiřadí osobě roli
ManageApi	check_individuals	HEAD /individual/data	Kontroluje existenci kolekce uživatelů
ManageApi	check_persons	HEAD /person/data	Kontroluje existenci kolekce subjektů
ManageApi	check_roles	HEAD /role/data	Kontroluje existenci kolekce rolí
ManageApi	check_tags	HEAD /tag/data	Kontroluje existenci kolekce tagů
ManageApi	export_individuals	GET /individual/data	Exportuje všechny uživatele ve formátu BSON
ManageApi	export_persons	GET /person/data	Exportuje všechny subjekty ve formátu BSON
ManageApi	export_roles	GET /role/data	Exportuje všechny role ve formátu BSON
ManageApi	export_tags	GET /tag/data	Exportuje všechny tagy ve formátu BSON
ManageApi	import_individuals	PUT /individual/data	Importuje uživatele
ManageApi	import_individuals_replace	POST /individual/data	Nahradí všechny uživatele
ManageApi	import_persons	PUT /person/data	Importuje subjekty
ManageApi	import_persons_replace	POST /person/data	Nahradí všechny subjekty
ManageApi	import_roles	PUT /role/data	Importuje role
ManageApi	import_roles_replace	POST /role/data	Nahradí všechny role
ManageApi	import_tags	PUT /tag/data	Importuje tagy
ManageApi	import_tags_replace	POST /tag/data	Nahradí všechny tagy
Manage2Api	get_all_individuals	GET /all/individuals	Vrací všechny uživatele pro Admin Portal
Manage2Api	get_all_persons	GET /all/persons	Vrací všechny subjekty pro Admin Portal
Manage2Api	get_all_roles	GET /all/roles	Vrací všechny role pro Admin Portal
Manage2Api	get_all_tags	GET /all/tags	Vrací všechny tagy pro Admin Portal
PublicApi	delete_individual	DELETE /individual/{identifier}	odstraní registrační dokument jednotlivce s daným identifikátorem (cruD)
PublicApi	delete_person	DELETE /person/{identifier}	odstraní registrační dokument subjektu s daným identifikátorem (cruD)
PublicApi	delete_role	DELETE /role/{identifier}	odstraní roli s daným identifikátorem (cruD)
PublicApi	get_context	GET /context/{identifier}	vrací kontext jednotlivce
PublicApi	get_individual	GET /individual/{identifier}	vrací registrační dokument jednotlivce s daným identifikátorem (cRud)
PublicApi	get_individual_list	GET /individual	vrací seznam jednotlivců (autocomplete)
PublicApi	get_person	GET /person/{identifier}	vrací registrační dokument subjektu s daným identifikátorem (cRud)
PublicApi	get_person_list	GET /person	vrací seznam subjektů (autocomplete)
PublicApi	get_role	GET /role/{identifier}	vrací roli s daným identifikátorem (cRud)
PublicApi	get_role_list	GET /role	vrací seznam rolí (autocomplete)
PublicApi	get_tag_list	GET /tag	vrací seznam tagů v systému (autocomplete)
PublicApi	post_individual	POST /individual	vytvoří nový egistrační záznam jednotlivého uživatele (Crud)
PublicApi	post_person	POST /person	vytvoří nový registrační záznam subjektu (Crud)
PublicApi	post_role	POST /role	vytvoří novou roli (Crud)
PublicApi	put_individual	PUT /individual/{identifier}	aktualizuje registrační dokument jednotlivce s daným identifikátorem (crUd)
PublicApi	put_person	PUT /person/{identifier}	aktualizuje registrační dokument subjektu s daným identifikátorem (crUd)
PublicApi	put_role	PUT /role/{identifier}	aktualizuje roli s daným identifikátorem (crUd)
ReferenceApi	delete_reference_person	DELETE /reference/person/{person_id}	Odstraní referenční strukturu osoby
ReferenceApi	get_reference_person	GET /reference/person/{reference_id}	Vrátí subjekt podle referečního uuid
ReferenceApi	get_reference_person_list	GET /reference/person	Vrátí subjekty s odkazem
ReferenceApi	post_reference_person	POST /reference/person/{person_id}	Zapíše referenční strukturu osoby
ReferenceApi	put_reference_person	PUT /reference/person/{person_id}	Přepíše referenční strukturu osoby
ReferenceApi	sync_crzp_person	POST /crzp/synchronize/person/{crzp_id}	Synchronizuje osobu s CRŽP
ReferenceApi	sync_person	POST /synchronize/person/{person_id}	Synchronizuje osobu

Documentation For Models

• BaseListSearchExtensionType
• BaseListType
• BirthDateType
• CodeValueType
• ContactType
• ContextType
• ContextTypePersons
• ContextTypeRoles
• DateTimeType
• DepartmentType
• DocumentEntry
• DocumentEntryList
• DocumentMetadataType
• ErrorModel
• GeoPointJtskType
• GeoPointType
• IdentifierType
• IndividualListType
• IndividualType
• IssuingType
• LocationType
• MailAddressType
• MemberType
• PersonLinkType
• PersonListItem
• PersonListType
• PersonType
• PersonTypeType
• PhoneNumberType
• PidType
• ReferenceRegistry
• RoleCategoryType
• RoleListItem
• RoleListType
• RoleType
• TagItemType
• TagListType
• TagType

Documentation For Authorization

apiKey

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Author

[e-mail]