Skip to content

Latest commit

 

History

History
53 lines (47 loc) · 5.26 KB

README.md

File metadata and controls

53 lines (47 loc) · 5.26 KB

Oracle query API Service

API service wrapper for CHIPS Oracle DB queries. This API should be used for all queries from CHS to the CHIPS database. This application is written using the Spring Boot Java framework.

Requirements

In order to run the API locally you'll need the following installed on your machine:

Getting Started

  1. Run make
  2. Run ./start.sh

Endpoints

Method Path Description
GET /emergency-auth-code/company/{incorporationNumber}/eligible-officers Calls service to retrieve eligible officers for company number
GET /emergency-auth-code/company/{companyNumber}/eligible-officers/{officerId} Calls service to retrieve officer for company number
GET /emergency-auth-code/company/{companyNumber}/efiling-status Calls service to check if company has filed in the past thirty days
GET /company/{companyNumber}/action-code Calls service to retrieve the current action code set against the company
GET /company/{companyNumber}/gaz2-requested Calls service to check if a gaz2 is requested for the company
GET /company/{companyNumber}/traded-status Calls service to retrieve the current traded status for the company
GET /officer-search/scottish-bankrupt-officers/{ephemeral_officer_key} Calls service to view the details for a Scottish bankrupt officer
POST /officer-search/scottish-bankrupt-officers Calls service to search for a Scottish bankrupt officer
GET /company/{companyNumber}/director/active Calls service to retrieve the active director details of a company
GET /company/{companyNumber}/shareholders/count Calls service to retrieve the number of active company shareholders
GET /company/{companyNumber}/shareholders Calls service to retrieve the list of all active company shareholders
GET /company/{companyNumber}/statement-of-capital Calls service to retrieve the statement of capital data for the company
GET /company/{companyNumber}/filing-history Calls service to retrieve the filing history transactions
GET /company/{companyNumber}/corporate-body-appointments/persons-of-significant-control Calls service to retrieve the psc data for the company
GET /company/{companyNumber}/confirmation-statement/paid Calls service to verify confirmation statement payment has been made for company on due date
GET /company/{companyNumber}/register/location Calls service to retrieve the registers locations for a company
GET /company/{companyNumber}/registered-email-address Calls service to retrieve the registered email address for a company
GET /overseas-entity/{companyNumber}/managing-officers Calls service to retrieve the managing officers for an overseas entity
GET /overseas-entity/{companyNumber}/beneficial-owners Calls service to retrieve the beneficial owner data for an overseas entity
GET /overseas-entity/{companyNumber}/trusts/details Calls service to retrieve the trust data for an overseas entity
GET /overseas-entity/trusts/{trustId}/individual-trustees Calls service to retrieve the individual trustee data for a trust
GET /overseas-entity/{oeNumber}/trusts/beneficial-owners/links Calls service to retrieve the trust link data for an overseas entity
GET /overseas-entity/trusts/{trustId}/corporate-trustees Calls service to retrieve the Trustee Data when given the ID of a Trust

Query parameters

Query parameter Description
items_per_page Number of items per page returned in this list
start_index Zero indexed, the offset into the entire list that this page starts at
payment_period_made_up_to_date The confirmation statement payment period made up to date to search for against a specified company when verifying payment for confirmation statement. Date must be ISO format yyyy-MM-dd e.g. 2019-03-31

Configuration

Key Description
ORACLE_QUERY_API_PORT The port of the oracle query api service
HUMAN_LOG For human readable logs