### Author search and retrieval example Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Complete example showing how to search authors by field, retrieve author by code, and get endpoint introduction. Includes pagination parameters and error handling. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.AuthorApi(swagger_client.ApiClient(configuration)) page = 0 # int | pagination for result page (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) author_code = 'author_code_example' # str | author_code (optional) author_name = 'author_name_example' # str | author_name (optional) award = 'award_example' # str | award (optional) collectives_of = 'collectives_of_example' # str | collectives_of (optional) main_field = 'main_field_example' # str | main_field (optional) in_collective = 'in_collective_example' # str | in_collective (optional) external_id_type = 'external_id_type_example' # str | external_id_type (optional) first_name = 'first_name_example' # str | first_name (optional) last_name = 'last_name_example' # str | last_name (optional) reviewer = 'reviewer_example' # str | reviewer (optional) spelling = 'spelling_example' # str | spelling (optional) state = 'state_example' # str | state (optional) try: # search authors by descriptive field names api_response = api_instance.get_author_by_field_author_structured_search_get(page=page, results_per_page=results_per_page, author_code=author_code, author_name=author_name, award=award, collectives_of=collectives_of, main_field=main_field, in_collective=in_collective, external_id_type=external_id_type, first_name=first_name, last_name=last_name, reviewer=reviewer, spelling=spelling, state=state) pprint(api_response) except ApiException as e: print("Exception when calling AuthorApi->get_author_by_field_author_structured_search_get: %s\n" % e) # create an instance of the API class api_instance = swagger_client.AuthorApi(swagger_client.ApiClient(configuration)) code = 'code_example' # str | try: # get author data by author code api_response = api_instance.get_author_by_zbmath_code_author_code_get(code) pprint(api_response) except ApiException as e: print("Exception when calling AuthorApi->get_author_by_zbmath_code_author_code_get: %s\n" % e) # create an instance of the API class api_instance = swagger_client.AuthorApi(swagger_client.ApiClient(configuration)) try: # introduction for user help regarding this endpoint api_response = api_instance.intro_author_get() pprint(api_response) except ApiException as e: print("Exception when calling AuthorApi->intro_author_get: %s\n" % e) ``` -------------------------------- ### Install via setuptools Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Install the package using setuptools for the current user or all users with sudo. ```sh python setup.py install --user ``` -------------------------------- ### Call intro_software_get with Python Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SoftwareApi.md Use this Python example to call the intro_software_get endpoint. It creates a SoftwareApi instance and prints the returned object. The endpoint requires no parameters and no authorization. The example catches ApiException and prints an error message. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SoftwareApi() try: # introduction for user help regarding this endpoint software api_response = api_instance.intro_software_get() pprint(api_response) except ApiException as e: print("Exception when calling SoftwareApi->intro_software_get: %s\n" % e) ``` -------------------------------- ### Install via pip from GitHub Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Install the package directly from the GitHub repository using pip. ```sh pip install git+https://github.com/zbMATHOpen/zbRestApiClient.git ``` -------------------------------- ### Python example for get_serial_by_syntax_string_serial_search_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SerialApi.md Example usage of the SerialApi.get_serial_by_syntax_string_serial_search_get method. It creates an API instance, sets search parameters, and handles the response or an ApiException. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SerialApi() search_string = 'search_string_example' # str | page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) try: # search serial meta data by zbMATH style user query api_response = api_instance.get_serial_by_syntax_string_serial_search_get(search_string, page=page, results_per_page=results_per_page) pprint(api_response) except ApiException as e: print("Exception when calling SerialApi->get_serial_by_syntax_string_serial_search_get: %s\n" % e) ``` -------------------------------- ### Search software by structured fields using get_software_by_field_software_structured_search_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SoftwareApi.md Python example for calling the GET /software/_structured_search endpoint. It creates a SoftwareApi instance, sets optional parameters (page, results_per_page, author, description, keyword, msc, name, programming_language), and handles ApiException errors. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SoftwareApi() page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) author = 'author_example' # str | author (optional) description = 'description_example' # str | description (optional) keyword = 'keyword_example' # str | keyword (optional) msc = 'msc_example' # str | msc (optional) name = 'name_example' # str | name (optional) programming_language = 'programming_language_example' # str | programming_language (optional) try: # search software meta data by descriptive field names api_response = api_instance.get_software_by_field_software_structured_search_get(page=page, results_per_page=results_per_page, author=author, description=description, keyword=keyword, msc=msc, name=name, programming_language=programming_language) pprint(api_response) except ApiException as e: print("Exception when calling SoftwareApi->get_software_by_field_software_structured_search_get: %s\n" % e) ``` -------------------------------- ### GET /software/ Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Introduction for user help regarding this endpoint software. ```APIDOC ## GET /software/ ### Description Introduction for user help regarding this endpoint software. ### Method GET ### Endpoint /software/ ``` -------------------------------- ### GET /software/{id} Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Get software data by software id. ```APIDOC ## GET /software/{id} ### Description Get software data by software id. ### Method GET ### Endpoint /software/{id} ``` -------------------------------- ### Import package after setuptools install Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Import the swagger_client module after installing via setuptools. ```python import swagger_client ``` -------------------------------- ### GET /document/ Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Introduction for user help regarding this endpoint. ```APIDOC ## GET /document/ ### Description Introduction for user help regarding this endpoint. ### Method GET ### Endpoint /document/ ``` -------------------------------- ### Get MSC2020 code data by code (get_classification_by_msc2020_code_classification_code_get) Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/ClassificationApi.md Example Python code using the swagger_client to call the get_classification_by_msc2020_code_classification_code_get endpoint. It creates an API instance, sets the code parameter, and prints the response. Requires the swagger_client library and handles ApiException errors. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.ClassificationApi() code = 'code_example' # str | try: # get msc2020 code data by code api_response = api_instance.get_classification_by_msc2020_code_classification_code_get(code) pprint(api_response) except ApiException as e: print("Exception when calling ClassificationApi->get_classification_by_msc2020_code_classification_code_get: %s\n" % e) ``` -------------------------------- ### Python example for get_author_by_syntax_string_author_search_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/AuthorApi.md Example usage of the AuthorApi.get_author_by_syntax_string_author_search_get method. It creates an API instance, sets search_string, page, and results_per_page parameters, calls the method, and prints the response. Exceptions are caught and printed. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.AuthorApi() search_string = 'search_string_example' # str | page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) try: # search authors by zbMATH style user query api_response = api_instance.get_author_by_syntax_string_author_search_get(search_string, page=page, results_per_page=results_per_page) pprint(api_response) except ApiException as e: print("Exception when calling AuthorApi->get_author_by_syntax_string_author_search_get: %s\n" % e) ``` -------------------------------- ### GET /author/ Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Introduction for user help regarding this endpoint. ```APIDOC ## GET /author/ ### Description Introduction for user help regarding this endpoint. ### Method GET ### Endpoint /author/ ``` -------------------------------- ### GET /intro_software_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SoftwareApi.md Returns an introduction for user help regarding the software search endpoint. This endpoint does not require any parameters and returns an object containing the help information. ```APIDOC ## GET /intro_software_get ### Description Returns an introduction for user help regarding the software search endpoint. This endpoint provides an overview of the available search fields and usage instructions for the software search functionality. ### Method GET ### Endpoint /intro_software_get ### Parameters This endpoint does not need any parameter. ### Request Example No request body required. ### Response #### Success Response (200) - Returns an **object** containing the introduction text. #### Response Example { "introduction": "For searching in zbMATH you may employ the Structured Search..." } ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ``` -------------------------------- ### GET /classification/{code} Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Get msc2020 code data by code. ```APIDOC ## GET /classification/{code} ### Description Get msc2020 code data by code. ### Method GET ### Endpoint /classification/{code} ``` -------------------------------- ### Python example for get_software_by_id_software_id_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SoftwareApi.md Use this endpoint when you have the exact zbMATH ID of the software. The result contains only one dataset corresponding to that ID. The example creates an instance of SoftwareApi and calls the method with an ID string, printing the response or catching an ApiException. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SoftwareApi() id = 'id_example' # str | try: # get software data by software id api_response = api_instance.get_software_by_id_software_id_get(id) pprint(api_response) except ApiException as e: print("Exception when calling SoftwareApi->get_software_by_id_software_id_get: %s\n" % e) ``` -------------------------------- ### GET /classification/ Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Introduction for user help regarding this endpoint. ```APIDOC ## GET /classification/ ### Description Introduction for user help regarding this endpoint. ### Method GET ### Endpoint /classification/ ``` -------------------------------- ### GET /intro_classification Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/ClassificationApi.md Returns an introduction to the classification search endpoint, explaining the available search fields and MSC code levels. Use this endpoint to get help on how to use the classification search. ```APIDOC ## GET /intro_classification ### Description Returns an introduction to the classification search endpoint, explaining the available search fields and MSC code levels. Use this endpoint to get help on how to use the classification search. ### Method GET ### Endpoint /intro_classification ### Parameters This endpoint does not need any parameter. ### Request Example No request body required. ### Response #### Success Response (200) - **object** - The introduction content as a JSON object. #### Response Example { "introduction": "For searching in zbMATH you may employ the Structured Search..." } ### Error Handling - **401** - Unauthorized: No authorization required, but if authentication fails. - **500** - Internal Server Error: An unexpected error occurred. ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ``` -------------------------------- ### GET /serial/{id} Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Get serial data by serial id. ```APIDOC ## GET /serial/{id} ### Description Get serial data by serial id. ### Method GET ### Endpoint /serial/{id} ``` -------------------------------- ### Import package after pip install Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Import the swagger_client module after installing the package. ```python import swagger_client ``` -------------------------------- ### Python example: get_msc2020_by_syntax_string_classification_search_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/ClassificationApi.md Calls the ClassificationApi.get_msc2020_by_syntax_string_classification_search_get method with a search string and optional pagination parameters. Prints the API response or an exception message. The example uses default values for page (0) and results_per_page (100) if not provided. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.ClassificationApi() search_string = 'search_string_example' # str | page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) try: # search msc codes meta data by zbMATH style user query api_response = api_instance.get_msc2020_by_syntax_string_classification_search_get(search_string, page=page, results_per_page=results_per_page) pprint(api_response) except ApiException as e: print("Exception when calling ClassificationApi->get_msc2020_by_syntax_string_classification_search_get: %s\n" % e) ``` -------------------------------- ### GET /serial/ Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Introduction for user help regarding this endpoint serial. ```APIDOC ## GET /serial/ ### Description Introduction for user help regarding this endpoint serial. ### Method GET ### Endpoint /serial/ ``` -------------------------------- ### GET /software/_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search software meta data by zbMATH style user query. ```APIDOC ## GET /software/_search ### Description Search software meta data by zbMATH style user query. ### Method GET ### Endpoint /software/_search ``` -------------------------------- ### Python example: get_serial_by_id_serial_id_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SerialApi.md Calls the SerialApi.get_serial_by_id_serial_id_get method with an ID and prints the response. Catches ApiException for errors. The ID is provided as a string. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SerialApi() id = 'id_example' # str | try: # get serial data by serial id api_response = api_instance.get_serial_by_id_serial_id_get(id) pprint(api_response) except ApiException as e: print("Exception when calling SerialApi->get_serial_by_id_serial_id_get: %s\n" % e) ``` -------------------------------- ### GET /software/_structured_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search software meta data by descriptive field names. ```APIDOC ## GET /software/_structured_search ### Description Search software meta data by descriptive field names. ### Method GET ### Endpoint /software/_structured_search ``` -------------------------------- ### GET /serial/_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search serial meta data by zbMATH style user query. ```APIDOC ## GET /serial/_search ### Description Search serial meta data by zbMATH style user query. ### Method GET ### Endpoint /serial/_search ``` -------------------------------- ### GET /intro_serial_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SerialApi.md Returns an introduction for user help regarding the serial search endpoint. This endpoint requires no parameters and returns an object containing the help information. ```APIDOC ## GET /intro_serial_get ### Description Returns an introduction for user help regarding the serial search endpoint. This endpoint provides an overview of the serial search functionality, including related endpoints for searching and retrieving serial metadata. ### Method GET ### Endpoint /intro_serial_get ### Parameters This endpoint does not need any parameter. ### Request Example No request body required. ### Response #### Success Response (200) - **body** (object) - The introduction content for the serial search endpoint. #### Response Example { "introduction": "For searching in zbMATH you may employ the Structured Search..." } ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ``` -------------------------------- ### Call DocumentApi.intro_document_get() in Python Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/DocumentApi.md Call the intro_document_get endpoint to retrieve the introduction for user help. No parameters are required and no authorization is needed. The response is an object and the Accept header is application/json. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.DocumentApi() try: # introduction for user help regarding this endpoint api_response = api_instance.intro_document_get() pprint(api_response) except ApiException as e: print("Exception when calling DocumentApi->intro_document_get: %s\n" % e) ``` -------------------------------- ### GET /document/{id} Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Get document data by zbMath ID. ```APIDOC ## GET /document/{id} ### Description Get document data by zbMath ID. ### Method GET ### Endpoint /document/{id} ``` -------------------------------- ### Call intro_classification_get with Python client Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/ClassificationApi.md Creates a ClassificationApi instance and calls intro_classification_get() to retrieve the introduction. Prints the response or catches an ApiException on failure. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.ClassificationApi() try: # introduction for user help regarding this endpoint api_response = api_instance.intro_classification_get() pprint(api_response) except ApiException as e: print("Exception when calling ClassificationApi->intro_classification_get: %s\n" % e) ``` -------------------------------- ### GET /author/{code} Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Get author data by author code. ```APIDOC ## GET /author/{code} ### Description Get author data by author code. ### Method GET ### Endpoint /author/{code} ``` -------------------------------- ### Call intro_serial_get with Python client Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SerialApi.md Use this Python example to call the intro_serial_get endpoint. It creates a SerialApi instance and invokes the method, printing the response or catching an ApiException. No parameters are required and no authorization is needed. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SerialApi() try: # introduction for user help regarding this endpoint serial api_response = api_instance.intro_serial_get() pprint(api_response) except ApiException as e: print("Exception when calling SerialApi->intro_serial_get: %s\n" % e) ``` -------------------------------- ### Call intro_author_get with Python Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/AuthorApi.md Use this Python example to call the intro_author_get endpoint. It creates an AuthorApi instance and invokes the method, printing the response. The endpoint requires no parameters and returns an object. No authorization is required. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.AuthorApi() try: # introduction for user help regarding this endpoint api_response = api_instance.intro_author_get() pprint(api_response) except ApiException as e: print("Exception when calling AuthorApi->intro_author_get: %s\n" % e) ``` -------------------------------- ### Python: Call get_software_by_syntax_string_software_search_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/SoftwareApi.md This snippet shows how to call the get_software_by_syntax_string_software_search_get method with the default page and results_per_page parameters. The search string must follow the zbMATH style syntax as described. The API instance is created from the swagger_client module. The example catches ApiException for error handling. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.SoftwareApi() search_string = 'search_string_example' # str | page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) try: # search software meta data by zbMATH style user query api_response = api_instance.get_software_by_syntax_string_software_search_get(search_string, page=page, results_per_page=results_per_page) pprint(api_response) except ApiException as e: print("Exception when calling SoftwareApi->get_software_by_syntax_string_software_search_get: %s\n" % e) ``` -------------------------------- ### GET /document/_structured_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search documents by descriptive field names. ```APIDOC ## GET /document/_structured_search ### Description Search documents by descriptive field names. ### Method GET ### Endpoint /document/_structured_search ``` -------------------------------- ### GET /author/_structured_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search authors by descriptive field names. ```APIDOC ## GET /author/_structured_search ### Description Search authors by descriptive field names. ### Method GET ### Endpoint /author/_structured_search ``` -------------------------------- ### GET /intro_author_get Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/AuthorApi.md Returns an introduction to the Author API, explaining how to use the structured search, syntax search, and direct author ID lookup to find author information including publications, co-authors, fields, and citation profiles. ```APIDOC ## GET /intro_author_get ### Description Returns an introduction to the Author API, explaining how to use the structured search, syntax search, and direct author ID lookup to find author information including publications, co-authors, fields, and citation profiles. ### Method GET ### Endpoint /intro_author_get ### Parameters This endpoint does not need any parameter. ### Request Example No request body required. ### Response #### Success Response (200) - **body** (object) - The introduction content as an object. #### Response Example { "introduction": "For searching in zbMATH you may employ the Structured Search, which allows for convenient search of all relevant fields. The syntax search on the other hand allows for free logical combinations of all available search fields and is much more flexible. In the following you will find a short explanation of available search fields. Use the Authors Search to find information on specific authors. Author profiles include indexed publications, co-authors, main fields, and a citation profile. - **/_search**: make use of the zbMATH search syntax for complex search. Examples on how to make use of the syntax can be found in the endpoint itself. - **/_structured_search**: a number of fields for a structured search - **/{id}**: if a zbMATH id for the author in question is available, you man enter it here, to return the meta data information of just this one author." } ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ``` -------------------------------- ### Search documents by zbMATH style user query using DocumentApi Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/docs/DocumentApi.md Calls the DocumentApi endpoint get_document_by_syntax_string_document_search_get with a search string and optional page and results_per_page parameters. The example sets page to 0 and results_per_page to 100 by default, and prints the response or an exception message. ```python from __future__ import print_function import time import swagger_client from swagger_client.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = swagger_client.DocumentApi() search_string = 'search_string_example' # str | page = 0 # int | (optional) (default to 0) results_per_page = 100 # int | (optional) (default to 100) try: # search documents by zbMATH style user query api_response = api_instance.get_document_by_syntax_string_document_search_get(search_string, page=page, results_per_page=results_per_page) pprint(api_response) except ApiException as e: print("Exception when calling DocumentApi->get_document_by_syntax_string_document_search_get: %s\n" % e) ``` -------------------------------- ### GET /author/_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search authors by zbMATH style user query. ```APIDOC ## GET /author/_search ### Description Search authors by zbMATH style user query. ### Method GET ### Endpoint /author/_search ``` -------------------------------- ### GET /document/_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search documents by zbMATH style user query. ```APIDOC ## GET /document/_search ### Description Search documents by zbMATH style user query. ### Method GET ### Endpoint /document/_search ``` -------------------------------- ### GET /serial/_structured_search Source: https://github.com/zbmathopen/zbrestapiclient/blob/master/README.md Search serial meta data by descriptive field names. ```APIDOC ## GET /serial/_structured_search ### Description Search serial meta data by descriptive field names. ### Method GET ### Endpoint /serial/_structured_search ```