CITES Documents data connector REST API 1.0.0
Project description
citesdoc
Toto je API pro Domino konektor ostatních dokumentů CITES
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- 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-citesdoc
Then import the package:
import citesdoc
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import citesdoc
from citesdoc.rest import ApiException
from pprint import pprint
# Configure API key authorization: apiKey
configuration = citesdoc.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 = citesdoc.AdminsApi(citesdoc.ApiClient(configuration))
doc_code = citesdoc.DocumentCode() # DocumentCode |
try:
# Odstraní položku šablony PDF (cruD)
api_instance.delete_template(doc_code)
except ApiException as e:
print("Exception when calling AdminsApi->delete_template: %s\n" % e)
# Configure API key authorization: apiKey
configuration = citesdoc.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 = citesdoc.AdminsApi(citesdoc.ApiClient(configuration))
doc_code = citesdoc.DocumentCode() # DocumentCode |
try:
# Vrátí šablonu PDF (cRud)
api_response = api_instance.get_template(doc_code)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_template: %s\n" % e)
# Configure API key authorization: apiKey
configuration = citesdoc.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 = citesdoc.AdminsApi(citesdoc.ApiClient(configuration))
try:
# Vrací seznam šablon
api_response = api_instance.get_template_list()
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminsApi->get_template_list: %s\n" % e)
# Configure API key authorization: apiKey
configuration = citesdoc.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 = citesdoc.AdminsApi(citesdoc.ApiClient(configuration))
body = citesdoc.TemplateType() # TemplateType | Definice šablony (optional)
try:
# Zavede novou položku šablony (Crud)
api_instance.post_template_item(body=body)
except ApiException as e:
print("Exception when calling AdminsApi->post_template_item: %s\n" % e)
# Configure API key authorization: apiKey
configuration = citesdoc.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 = citesdoc.AdminsApi(citesdoc.ApiClient(configuration))
doc_code = citesdoc.DocumentCode() # DocumentCode |
body = citesdoc.Object() # Object | Upload soubor PDF nebo JRXML, případně ZIP u vícesouborové šablony (optional)
enclosure = false # bool | Indikátor, zda se jedná o šablonu přílohy nebo první stránky (optional) (default to false)
filename = 'filename_example' # str | Nový název souboru. Pokud není zadáno, použije se název uložený v systému (optional)
try:
# Nahraje soubor se šablonou PDF nebo změní definici šablony (crUd)
api_instance.put_template(doc_code, body=body, enclosure=enclosure, filename=filename)
except ApiException as e:
print("Exception when calling AdminsApi->put_template: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://valpha.sysnet.cz/SYSNET/CITES_other_doc/1.0.0
Class | Method | HTTP request | Description |
---|---|---|---|
AdminsApi | delete_template | DELETE /template/{docCode} | Odstraní položku šablony PDF (cruD) |
AdminsApi | get_template | GET /template/{docCode} | Vrátí šablonu PDF (cRud) |
AdminsApi | get_template_list | GET /template | Vrací seznam šablon |
AdminsApi | post_template_item | POST /template | Zavede novou položku šablony (Crud) |
AdminsApi | put_template | PUT /template/{docCode} | Nahraje soubor se šablonou PDF nebo změní definici šablony (crUd) |
DevelopersApi | info_api | GET /info | vrací servisní informace |
DevelopersApi | info_api_head | HEAD /info | vrací informaci o dostupnosti služby |
PublicApi | delete_document | DELETE /doc/{identifier} | Odstraní dokument (cruD) |
PublicApi | get_document | GET /doc/{identifier} | Vrací konkrétní dokument (cRud) |
PublicApi | get_document_list | GET /doc | Vrací seznam dokumentů podle klíče nebo kódu |
PublicApi | get_pdf_file | GET /pdf/{identifier} | Vrací PDF dokument |
PublicApi | get_xfdf | GET /xfdf/{identifier} | Vrací XFDF data dokumentu |
PublicApi | post_document | POST /doc | Vytvoří nový dokument (Crud) |
PublicApi | put_document | PUT /doc/{identifier} | Aktualizuje dokument (crUd) |
Documentation For Models
- BaseDocumentType
- ConditionsType
- DocumentCode
- DocumentEntryListType
- DocumentEntryType
- ErrorModel
- GeneralType
- GoodsType
- IssuingType
- MetadataType
- OtherType
- PersonType
- TaxonType
- TemplateType
- TransactionType
- XfdfFieldType
- XfdfListType
- XfdfType
- XfdfTypeIdentifier
- XfdfTypeTemplateFile
Documentation For Authorization
apiKey
- Type: API key
- API key parameter name: X-API-KEY
- Location: HTTP header
Author
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
sysnet-citesdoc-1.0.0.1.tar.gz
(44.2 kB
view hashes)
Built Distribution
Close
Hashes for sysnet_citesdoc-1.0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3557c7cfe8ddcdc20d406b323800adfca73754732f8d6b42973a8611d468521b |
|
MD5 | a1fcc31266badcadc74802d655abacfd |
|
BLAKE2b-256 | 93cb56ec2b738277d058a28d6d7377f72ae96a6b052a318ba308b426d3110b7a |