orcid_api package¶
Subpackages¶
- orcid_api.apis package
- orcid_api.models package
- Submodules
- orcid_api.models.activities_summary module
- orcid_api.models.address module
- orcid_api.models.amount module
- orcid_api.models.authorization_url module
- orcid_api.models.bulk_element module
- orcid_api.models.citation module
- orcid_api.models.contributor module
- orcid_api.models.contributor_attributes module
- orcid_api.models.contributor_email module
- orcid_api.models.contributor_orcid module
- orcid_api.models.country module
- orcid_api.models.created_date module
- orcid_api.models.credit_name module
- orcid_api.models.day module
- orcid_api.models.disambiguated_organization module
- orcid_api.models.education module
- orcid_api.models.education_summary module
- orcid_api.models.educations module
- orcid_api.models.employment module
- orcid_api.models.employment_summary module
- orcid_api.models.employments module
- orcid_api.models.external_i_ds module
- orcid_api.models.external_id module
- orcid_api.models.funding module
- orcid_api.models.funding_contributor module
- orcid_api.models.funding_contributor_attributes module
- orcid_api.models.funding_contributors module
- orcid_api.models.funding_group module
- orcid_api.models.funding_summary module
- orcid_api.models.funding_title module
- orcid_api.models.fundings module
- orcid_api.models.fuzzy_date module
- orcid_api.models.group_id_record module
- orcid_api.models.group_id_records module
- orcid_api.models.item module
- orcid_api.models.items module
- orcid_api.models.keyword module
- orcid_api.models.last_modified_date module
- orcid_api.models.month module
- orcid_api.models.notification module
- orcid_api.models.notification_permission module
- orcid_api.models.organization module
- orcid_api.models.organization_address module
- orcid_api.models.organization_defined_funding_sub_type module
- orcid_api.models.other_name module
- orcid_api.models.peer_review module
- orcid_api.models.peer_review_group module
- orcid_api.models.peer_review_summary module
- orcid_api.models.peer_reviews module
- orcid_api.models.person_external_identifier module
- orcid_api.models.publication_date module
- orcid_api.models.researcher_url module
- orcid_api.models.source module
- orcid_api.models.source_client_id module
- orcid_api.models.source_name module
- orcid_api.models.source_orcid module
- orcid_api.models.subtitle module
- orcid_api.models.title module
- orcid_api.models.transient_non_empty_string module
- orcid_api.models.translated_title module
- orcid_api.models.url module
- orcid_api.models.work module
- orcid_api.models.work_bulk module
- orcid_api.models.work_contributors module
- orcid_api.models.work_group module
- orcid_api.models.work_summary module
- orcid_api.models.work_title module
- orcid_api.models.works module
- orcid_api.models.year module
- Module contents
Submodules¶
orcid_api.api_client module¶
ORCID Member
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: Latest
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
class
orcid_api.api_client.
ApiClient
(host=None, header_name=None, header_value=None, cookie=None)¶ Bases:
object
Generic API client for Swagger client library builds.
Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.
NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.
Parameters: - host – The base path for the server to call.
- header_name – a header to pass when making calls to the API.
- header_value – a header value to pass when making calls to the API.
-
NATIVE_TYPES_MAPPING
= {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}¶
-
PRIMITIVE_TYPES
= (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)¶
-
call_api
(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)¶ Makes the HTTP request (synchronous) and return the deserialized data. To make an async request, define a function for callback.
Parameters: - resource_path – Path to method endpoint.
- method – Method to call.
- path_params – Path parameters in the url.
- query_params – Query parameters in the url.
- header_params – Header parameters to be placed in the request header.
- body – Request body.
- dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
- list (auth_settings) – Auth Settings names for the request.
- response – Response data type.
- dict – key -> filename, value -> filepath, for multipart/form-data.
- function (callback) – Callback function for asynchronous request. If provide this parameter, the request will be called asynchronously.
- _return_http_data_only – response data without head status code and headers
- collection_formats – dict of collection formats for path, query, header, and post parameters.
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns: If provide parameter callback, the request will be called asynchronously. The method will return the request thread. If parameter callback is None, then the method will return the response directly.
-
deserialize
(response, response_type)¶ Deserializes response into an object.
Parameters: - response – RESTResponse object to be deserialized.
- response_type – class literal for deserialized object, or string of class name.
Returns: deserialized object.
-
parameters_to_tuples
(params, collection_formats)¶ Get parameters as list of tuples, formatting collections.
Parameters: - params – Parameters as dict or list of two-tuples
- collection_formats (dict) – Parameter collection formats
Returns: Parameters as list of tuples, collections formatted
-
prepare_post_parameters
(post_params=None, files=None)¶ Builds form parameters.
Parameters: - post_params – Normal form parameters.
- files – File parameters.
Returns: Form parameters with files.
-
request
(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶ Makes the HTTP request using RESTClient.
-
sanitize_for_serialization
(obj)¶ Builds a JSON POST object.
If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date
convert to string in iso8601 format.If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.
Parameters: obj – The data to serialize. Returns: The serialized form of data.
-
select_header_accept
(accepts)¶ Returns Accept based on an array of accepts provided.
Parameters: accepts – List of headers. Returns: Accept (e.g. application/json).
-
select_header_content_type
(content_types)¶ Returns Content-Type based on an array of content_types provided.
Parameters: content_types – List of content-types. Returns: Content-Type (e.g. application/json).
-
set_default_header
(header_name, header_value)¶
-
update_params_for_auth
(headers, querys, auth_settings)¶ Updates header and query params based on authentication setting.
Parameters: - headers – Header parameters dict to be updated.
- querys – Query parameters tuple list to be updated.
- auth_settings – Authentication setting identifiers list.
-
user_agent
¶ Gets user agent.
orcid_api.configuration module¶
ORCID Member
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: Latest
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
orcid_api.configuration.
Configuration
()¶
-
orcid_api.configuration.
singleton
(cls, *args, **kw)¶
orcid_api.rest module¶
ORCID Member
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: Latest
Generated by: https://github.com/swagger-api/swagger-codegen.git
-
exception
orcid_api.rest.
ApiException
(status=None, reason=None, http_resp=None)¶ Bases:
Exception
-
class
orcid_api.rest.
RESTClientObject
(pools_size=4, maxsize=4)¶ Bases:
object
-
DELETE
(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
GET
(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)¶
-
HEAD
(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)¶
-
OPTIONS
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
PATCH
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
POST
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
PUT
(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)¶
-
request
(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)¶ Parameters: - method – http request method
- url – http request url
- query_params – query parameters in the url
- headers – http request headers
- body – request json body, for application/json
- post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data
- _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
- _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
-
Module contents¶
ORCID Member
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
OpenAPI spec version: Latest
Generated by: https://github.com/swagger-api/swagger-codegen.git