safepeopleregistry-api-sdk

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.36.0
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/HDRUK/safepeopleregistry-api-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/HDRUK/safepeopleregistry-api-python-sdk.git)

Then import the package:

import safepeopleregistry_api_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import safepeopleregistry_api_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import safepeopleregistry_api_sdk
from safepeopleregistry_api_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = safepeopleregistry_api_sdk.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with safepeopleregistry_api_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = safepeopleregistry_api_sdk.CustodianUserApi(api_client)
    custodian_user_bulk_store_request = safepeopleregistry_api_sdk.CustodianUserBulkStoreRequest() # CustodianUserBulkStoreRequest | Array of CustodianUser definitions

    try:
        # Create multiple CustodianUser entries
        api_response = api_instance.custodian_user_bulk_store(custodian_user_bulk_store_request)
        print("The response of CustodianUserApi->custodian_user_bulk_store:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CustodianUserApi->custodian_user_bulk_store: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CustodianUserApi	custodian_user_bulk_store	POST /api/v1/custodian_users/bulk	Create multiple CustodianUser entries
FeatureApi	feature_index	GET /api/v1/features	Feature@index
ProjectUsersApi	project_users_bulk_invite_project_users	POST /api/v1/project_users/bulk	Bulk invite Project Users
QueryApi	query_query	POST /api/v1/query	Query@query
VendorWebhookReceiverApi	vendor_webhook_receiver_receive	POST /api/v1/webhooks/{provider}	Receive a webhook callback from a vendor

Documentation For Models

• Accreditation
• ActionLog
• Affiliation
• Charity
• Custodian
• CustodianHasProjectOrganisation
• CustodianHasProjectUser
• CustodianModelConfig
• CustodianUser
• CustodianUserBulkStore201Response
• CustodianUserBulkStore500Response
• CustodianUserBulkStoreRequest
• CustodianUserBulkStoreRequestUsersInner
• CustodianUserHasPermission
• CustodianWebhookReceiver
• DebugLog
• DecisionModel
• DecisionModelType
• Department
• Education
• Endorsement
• Experience
• FeatureIndex200Response
• FeatureIndex200ResponseData
• FeatureIndex404Response
• File
• History
• IDVTPlugin
• Identity
• Infringement
• InfringementHasResolution
• ModelState
• ONSFile
• Organisation
• OrganisationHasCharity
• OrganisationHasCustodianPermission
• OrganisationHasDepartment
• OrganisationHasFile
• OrganisationHasSubsidiary
• PendingInvite
• Permission
• ProfessionalRegistration
• Project
• ProjectDetail
• ProjectHasCustodian
• ProjectHasOrganisation
• ProjectHasRole
• ProjectHasUser
• ProjectRole
• ProjectUsersBulkInviteProjectUsersRequest
• ProjectUsersBulkInviteProjectUsersRequestUsersInner
• QueryQuery200Response
• QueryQuery200ResponseData
• QueryQuery200ResponseDataProjectsInner
• QueryQuery200ResponseDataRegistry
• QueryQuery200ResponseDataRegistryAllOfHistoryInner
• QueryQuery200ResponseDataUser
• QueryQuery401Response
• QueryQueryRequest
• Registry
• RegistryHasAccreditation
• RegistryHasAffiliation
• RegistryHasEducation
• RegistryHasFile
• RegistryHasHistory
• RegistryHasProfessionalRegistration
• RegistryHasTraining
• Resolution
• Sector
• SsoTenant
• SsoTenantDomain
• State
• Subsidiary
• SystemConfig
• Training
• TrainingHasFile
• UksaLiveFeed
• User
• UserHasCustodianPermission
• UserHasDepartments
• ValidationCheck
• ValidationLog
• ValidationLogComment
• VendorWebhookReceiverReceive200Response
• VendorWebhookReceiverReceive400Response
• VendorWebhookReceiverReceive500Response
• WebhookEventTrigger

Documentation For Authorization

Endpoints do not require authorization.

Author