title_expert

TitleExpert - the Ruby gem for the ACS Title Expert

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build title_expert.gemspec

Then either install the gem locally:

gem install ./title_expert-1.0.0.gem

(for development, run gem install --dev ./title_expert-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 'title_expert', '~> 1.0.0'

Install from Git

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

gem 'title_expert', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.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 'title_expert'

# Setup authorization
TitleExpert.configure do |config|
  # Configure HTTP basic authorization: basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = TitleExpert::AddressNormalisationAndMatchingApi.new

clientid = "clientid_example" # String | Your client id.

addresses = TitleExpert::AddressMatchRequest.new # AddressMatchRequest | The addresses to be compared.


begin
  #Compares two addresses on a \"logical first line and postcode\" basis.
  result = api_instance.address_match_match(clientid, addresses)
  p result
rescue TitleExpert::ApiError => e
  puts "Exception when calling AddressNormalisationAndMatchingApi->address_match_match: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://titleexpert.co.uk

Class	Method	HTTP request	Description
TitleExpert::AddressNormalisationAndMatchingApi	address_match_match	POST /api/{clientid}/addressmatch/match	Compares two addresses on a "logical first line and postcode" basis.
TitleExpert::AddressNormalisationAndMatchingApi	address_match_normalise	POST /api/{clientid}/addressmatch/normalise	Normalise an address by concatenating lines, singling multiple spaces, removing punctuation and doing things like replacing "Road" by "Rd".
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_acknowledge_dequeued	POST /api/{clientid}/bankruptcysearches/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_acknowledge_request	POST /api/{clientid}/bankruptcysearches/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_create_request	POST /api/{clientid}/bankruptcysearches	Issue a K16 request, Bankruptcy Search. This will incur a charge.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_dequeue_next_ready_for_ack	POST /api/{clientid}/bankruptcysearches/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_get_document	GET /api/{clientid}/bankruptcysearches/{requestid}/{documentid}	Get one of the documents returned by a Bankruptcy Search request.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_get_request	GET /api/{clientid}/bankruptcysearches/{requestid}	Get the current status of a Bankruptcy Search request.
TitleExpert::BankruptcySearchK16Api	bankruptcy_search_search	GET /api/{clientid}/bankruptcysearches	Search for Bankruptcy Search requests meeting the specified criteria.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_acknowledge_dequeued	POST /api/{clientid}/customcheck/BorrowerNameMatch/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_acknowledge_request	POST /api/{clientid}/customcheck/BorrowerNameMatch/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_create_request	POST /api/{clientid}/customcheck/BorrowerNameMatch	Check the supplied set of borrower names against the registered proprietors in the identified TitleData request.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_dequeue_next_ready_for_ack	POST /api/{clientid}/customcheck/BorrowerNameMatch/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_get_request	GET /api/{clientid}/customcheck/BorrowerNameMatch/{requestid}	Retrieve the results of a Borrower Name Match.
TitleExpert::BorrowerNameMatchApi	borrower_name_match_search_requests	GET /api/{clientid}/customcheck/BorrowerNameMatch	Search for Borrower Name Match requests meeting the specified criteria.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_acknowledge_dequeued	POST /api/{clientid}/searchesofwhole/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_acknowledge_request	POST /api/{clientid}/searchesofwhole/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_create_request	POST /api/{clientid}/searchesofwhole	Issue an OS1 request, Official Search of Whole with Priority. This will incur a charge.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_dequeue_next_ready_for_ack	POST /api/{clientid}/searchesofwhole/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_get_document	GET /api/{clientid}/searchesofwhole/{requestid}/{documentid}	Get one of the documents returned by an Official Search request.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_get_request	GET /api/{clientid}/searchesofwhole/{requestid}	Get the current status of an Official Search request.
TitleExpert::OfficialSearchOfWholeWithPriorityOS1Api	search_of_whole_search	GET /api/{clientid}/searchesofwhole	Search for Official Search requests meeting the specified criteria.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_acknowledge_dequeued	POST /api/{clientid}/ownershipverify/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_acknowledge_request	POST /api/{clientid}/ownershipverify/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_dequeue_next_ready_for_ack	POST /api/{clientid}/ownershipverify/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_get_response	GET /api/{clientid}/ownershipverify/{requestid}	Get the current status of an Online Ownership Verification request.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_get_results	GET /api/{clientid}/ownershipverify/{requestid}/results	Get the results of a complete Online Ownership Verification request.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_search_requests	GET /api/{clientid}/ownershipverify	Search for Online Ownership Verification requests meeting the specified criteria.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_verify_by_address	POST /api/{clientid}/ownershipverify/address	Issue a request for Online Ownership Verification against a property address. This will incur a charge.
TitleExpert::OnlineOwnershipVerificationOOVApi	ownership_verification_verify_by_title	POST /api/{clientid}/ownershipverify/title	Issue a request for Online Ownership Verification against a known Title Number. This will incur a charge.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_acknowledge_dequeued	POST /api/{clientid}/titlechecks/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_acknowledge_request	POST /api/{clientid}/titlechecks/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_create_check_xml_request	POST /api/{clientid}/titlechecks/xml	Issue a request for Title Checking of user-supplied Title Data and optional Documents.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_create_data_request	POST /api/{clientid}/titlechecks	Issue a request for Title Data and perform title checks. This will incur a charge.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_dequeue_next_ready_for_ack	POST /api/{clientid}/titlechecks/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_get_check_results	GET /api/{clientid}/titlechecks/{requestid}/checkresults	Get the massaged data extract and list of issues resulting from a Title Data request.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_get_document	GET /api/{clientid}/titlechecks/{requestid}/{documentid}	Get one of the documents for a Title Data request.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_get_request	GET /api/{clientid}/titlechecks/{requestid}	Get the current status of a Title Data request.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_get_res_data	GET /api/{clientid}/titlechecks/{requestid}/resdata	(DEPRECATED) Get the raw Registry Extract Service data for a Title Data request as an object.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_get_res_document	GET /api/{clientid}/titlechecks/{requestid}/resdocument	Get the raw Registry Extract Service data for a Title Data request as an XML document.
TitleExpert::TitleDataChecksRESOfficialCopyWithSummaryApi	title_data_search	GET /api/{clientid}/titlechecks	Search for Title Data requests meeting the specified criteria.
TitleExpert::TitleDocumentsOC2Api	title_documents_acknowledge_dequeued	POST /api/{clientid}/documents/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::TitleDocumentsOC2Api	title_documents_acknowledge_request	POST /api/{clientid}/documents/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::TitleDocumentsOC2Api	title_documents_create_request	POST /api/{clientid}/documents	Issue a request for Title Documents (OC2). Will continue if applications are pending against the Title (returning back-dated) or if closed and continued (under the new Title number). This will incur a charge.
TitleExpert::TitleDocumentsOC2Api	title_documents_dequeue_next_ready_for_ack	POST /api/{clientid}/documents/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::TitleDocumentsOC2Api	title_documents_get_document	GET /api/{clientid}/documents/{requestid}/{documentid}	Get one of the documents returned by a Title Documents request.
TitleExpert::TitleDocumentsOC2Api	title_documents_get_request	GET /api/{clientid}/documents/{requestid}	Get the current status of a Title Documents request.
TitleExpert::TitleDocumentsOC2Api	title_documents_search	GET /api/{clientid}/documents	Search for Title Documents requests meeting the specified criteria.
TitleExpert::TitleNumbersePDEnquiryByPropertyDescriptionApi	title_numbers_search	GET /api/{clientid}/titlenumbers	Search for the title number(s) for an address (ePD, Enquiry by Property Description).
TitleExpert::TitlePlanOC1Api	title_plan_acknowledge_dequeued	POST /api/{clientid}/titleplan/{requestid}/ack-next-ready	Acknowledge receipt of the result of a Request that was retrieved from the get-next-ready endpoint.
TitleExpert::TitlePlanOC1Api	title_plan_acknowledge_request	POST /api/{clientid}/titleplan/{requestid}/ack	Acknowledge receipt of the result of a Request that was not retrieved from the get-next-ready endpoint.
TitleExpert::TitlePlanOC1Api	title_plan_dequeue_next_ready_for_ack	POST /api/{clientid}/titleplan/get-next-ready	Gets the next earliest-started Request which has finished and has not yet been Acknowledged. The request will be locked for a certain time window within which it will not be available from get-next-ready. Normally, you will Acknowledge within this time window as part of your processing of the results.
TitleExpert::TitlePlanOC1Api	title_plan_get_document	GET /api/{clientid}/titleplan/{requestid}/{documentid}	Gets the Title Plan PDF.
TitleExpert::TitlePlanOC1Api	title_plan_get_result	GET /api/{clientid}/titleplan/{requestid}	Get the current status of a Title Plan request.
TitleExpert::TitlePlanOC1Api	title_plan_search	GET /api/{clientid}/titleplan	Search for Title Plan requests meeting the specified criteria.
TitleExpert::TitlePlanOC1Api	title_plan_submit_request	POST /api/{clientid}/titleplan	Issue a request for a Title Plan (OC1). Will continue if applications are pending against the Title (returning back-dated) or if closed and continued (under the new Title number). This will incur a charge.

Documentation for Models

• TitleExpert::Address
• TitleExpert::AddressLineType
• TitleExpert::AddressMatchRequest
• TitleExpert::AddressMatchResponse
• TitleExpert::AdministrativeAreaTextType
• TitleExpert::AlternativeDespatchDetails
• TitleExpert::ApiError
• TitleExpert::BankruptcyRequest
• TitleExpert::BankruptcyResponse
• TitleExpert::Borrower
• TitleExpert::BorrowerNameMatchDetails
• TitleExpert::BorrowerNameMatchIssue
• TitleExpert::BorrowerNameMatchRequest
• TitleExpert::BorrowerNameMatchResponse
• TitleExpert::CharityCodeType
• TitleExpert::ClassOfTitleCodeType
• TitleExpert::ClientParameters
• TitleExpert::DXAddress
• TitleExpert::DateTimeType
• TitleExpert::DateType
• TitleExpert::DistrictNameTextType
• TitleExpert::Document
• TitleExpert::DocumentsRequest
• TitleExpert::DocumentsResponse
• TitleExpert::ErrorItemDetails
• TitleExpert::ExtraTitleNumber
• TitleExpert::FormPRestriction
• TitleExpert::HistoricalMatch
• TitleExpert::IndicatorType1
• TitleExpert::Issue
• TitleExpert::ItemDetailsApiError
• TitleExpert::LRAddress
• TitleExpert::LRBGPrice
• TitleExpert::LandRegistryOfficeNameTextType
• TitleExpert::Lease
• TitleExpert::LeaseTermTextType
• TitleExpert::LrbgApiError
• TitleExpert::LrbgItemDetailsApiError
• TitleExpert::LrbgResponseCommon
• TitleExpert::Match
• TitleExpert::MatchInfo
• TitleExpert::Name
• TitleExpert::NamedBlob
• TitleExpert::NumericType
• TitleExpert::OC2DocumentSpec
• TitleExpert::OCName
• TitleExpert::Object
• TitleExpert::OfficialSearchRequest
• TitleExpert::OfficialSearchResponse
• TitleExpert::OwnerVerifyByAddressRequest
• TitleExpert::OwnerVerifyByTitleRequest
• TitleExpert::OwnerVerifyName
• TitleExpert::OwnerVerifyResponse
• TitleExpert::OwnerVerifyResult
• TitleExpert::Party
• TitleExpert::PostalAddress
• TitleExpert::PropertyAddress
• TitleExpert::PropertyAddressSearch
• TitleExpert::PropertyData
• TitleExpert::ProprietorsData
• TitleExpert::Q1AddressType
• TitleExpert::Q1AgreedNoticeType
• TitleExpert::Q1ChargeDetailsType
• TitleExpert::Q1ChargeProprietorType
• TitleExpert::Q1ChargeType
• TitleExpert::Q1CharityDetailsType
• TitleExpert::Q1DocumentEntryType
• TitleExpert::Q1EntryDetailsType
• TitleExpert::Q1HomeRightsType
• TitleExpert::Q1LeaseType
• TitleExpert::Q1OCRegisterDataType
• TitleExpert::Q1OCSummaryDataType
• TitleExpert::Q1PartyType
• TitleExpert::Q1PostcodeZoneType
• TitleExpert::Q1PricePaidEntryType
• TitleExpert::Q1ProprietorshipType
• TitleExpert::Q1RegisterEntryIndicatorsType
• TitleExpert::Q1RegisterEntryType
• TitleExpert::Q1RegisterType
• TitleExpert::Q1RestrictionEntryType
• TitleExpert::Q1RestrictionType
• TitleExpert::Q1ScheduleType
• TitleExpert::Q1SubChargeDetailsType
• TitleExpert::Q1TitleRegistrationDetailsType
• TitleExpert::Q1TitleType
• TitleExpert::Q1UnilateralNoticeDetailsType
• TitleExpert::Q2TextType1
• TitleExpert::RawAddress
• TitleExpert::Reference
• TitleExpert::RegisterEntry
• TitleExpert::RegisteredCharge
• TitleExpert::RegisteredChargesData
• TitleExpert::RentAmountTextType
• TitleExpert::RequestParams
• TitleExpert::ResponseCommon
• TitleExpert::RestrictionCodeType
• TitleExpert::ReturnedDocument
• TitleExpert::ReturnedDocuments
• TitleExpert::SavedRESData
• TitleExpert::ScheduleOfLeases
• TitleExpert::ScheduleOfLeasesEntry
• TitleExpert::SubjectProperty
• TitleExpert::TextType
• TitleExpert::TitleCheckResults
• TitleExpert::TitleCheckXmlRequest
• TitleExpert::TitleDataExtract
• TitleExpert::TitleDataRequest
• TitleExpert::TitleDataResponse
• TitleExpert::TitleDetails
• TitleExpert::TitleNumbersResult
• TitleExpert::TitlePlanRequest
• TitleExpert::TitlePlanResponse

Documentation for Authorization

basic

• Type: HTTP basic authentication