safepeopleregistry-api-sdk

Safe People Registry API

• API version: 1.0.0
  • Build date: 2026-09-11T15:06:32.818197734Z[Etc/UTC]
  • Generator version: 7.24.0

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

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>uk.ac.hdruk.safepeopleregistryapi</groupId>
  <artifactId>safepeopleregistry-api-sdk</artifactId>
  <version>1.36.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'safepeopleregistry-api-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'safepeopleregistry-api-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "uk.ac.hdruk.safepeopleregistryapi:safepeopleregistry-api-sdk:1.36.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/safepeopleregistry-api-sdk-1.36.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import uk.ac.hdruk.safepeopleregistryapi.ApiClient;
import uk.ac.hdruk.safepeopleregistryapi.ApiException;
import uk.ac.hdruk.safepeopleregistryapi.Configuration;
import uk.ac.hdruk.safepeopleregistryapi.model.*;
import uk.ac.hdruk.safepeopleregistryapi.api.CustodianUserApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    CustodianUserApi apiInstance = new CustodianUserApi(defaultClient);
    CustodianUserBulkStoreRequest custodianUserBulkStoreRequest = new CustodianUserBulkStoreRequest(); // CustodianUserBulkStoreRequest | Array of CustodianUser definitions
    try {
      CustodianUserBulkStore201Response result = apiInstance.custodianUserBulkStore(custodianUserBulkStoreRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CustodianUserApi#custodianUserBulkStore");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CustodianUserApi	custodianUserBulkStore	POST /api/v1/custodian_users/bulk	Create multiple CustodianUser entries
FeatureApi	featureIndex	GET /api/v1/features	Feature@index
ProjectUsersApi	projectUsersBulkInviteProjectUsers	POST /api/v1/project_users/bulk	Bulk invite Project Users
QueryApi	queryQuery	POST /api/v1/query	Query@query
VendorWebhookReceiverApi	vendorWebhookReceiverReceive	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
• History
• IDVTPlugin
• Identity
• Infringement
• InfringementHasResolution
• ModelFile
• 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.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author