openapi_client

OpenapiClient - the Ruby gem for the DQT API

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

This SDK is automatically generated by the OpenAPI Generator project:

• API version: v2
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'openapi_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'openapi_client'

# Setup authorization
OpenapiClient.configure do |config|
  # Configure Bearer authorization: Bearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = OpenapiClient::IttOutcomeApi.new
trn = 'trn_example' # String | The TRN of the teacher to set ITT outcome for.
opts = {
  set_itt_outcome_request: OpenapiClient::SetIttOutcomeRequest.new({itt_provider_ukprn: 'itt_provider_ukprn_example', outcome: OpenapiClient::IttOutcome::PASS}) # SetIttOutcomeRequest | 
}

begin
  #Sets ITT outcome for a teacher
  result = api_instance.v2_teachers_trn_itt_outcome_put(trn, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Exception when calling IttOutcomeApi->v2_teachers_trn_itt_outcome_put: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
OpenapiClient::IttOutcomeApi	v2_teachers_trn_itt_outcome_put	PUT /v2/teachers/{trn}/itt-outcome	Sets ITT outcome for a teacher
OpenapiClient::IttProvidersApi	v2_itt_providers_get	GET /v2/itt-providers	Gets a list of all ITT Providers
OpenapiClient::TeachersApi	v2_teachers_find_get	GET /v2/teachers/find	Returns teachers matching the specified criteria
OpenapiClient::TrnRequestsApi	v2_trn_requests_request_id_get	GET /v2/trn-requests/{requestId}	Retrieves a TRN request
OpenapiClient::TrnRequestsApi	v2_trn_requests_request_id_put	PUT /v2/trn-requests/{requestId}	Creates a request for a TRN
OpenapiClient::UnlockTeacherApi	v2_unlock_teacher_teacher_id_put	PUT /v2/unlock-teacher/{teacherId}

Documentation for Models

• OpenapiClient::ClassDivision
• OpenapiClient::FindTeacherResult
• OpenapiClient::FindTeachersResponse
• OpenapiClient::Gender
• OpenapiClient::GetIttProvidersResponse
• OpenapiClient::GetOrCreateTrnRequest
• OpenapiClient::GetOrCreateTrnRequestAddress
• OpenapiClient::GetOrCreateTrnRequestInitialTeacherTraining
• OpenapiClient::GetOrCreateTrnRequestQualification
• OpenapiClient::IttOutcome
• OpenapiClient::IttProgrammeType
• OpenapiClient::IttProviderInfo
• OpenapiClient::ProblemDetails
• OpenapiClient::SetIttOutcomeRequest
• OpenapiClient::SetIttOutcomeResponse
• OpenapiClient::TrnRequestInfo
• OpenapiClient::TrnRequestStatus

Documentation for Authorization

Bearer

• Type: Bearer authentication