Giter Club home page Giter Club logo

companieshouse.oracle-query-api's Introduction

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 /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

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

Configuration

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

companieshouse.oracle-query-api's People

Contributors

daisysanson avatar damiandunajski avatar emead avatar gevans-ch avatar icoxch avatar joseph-nash avatar jphillips2121 avatar jsimons1989 avatar macreman avatar phonologicalloop avatar rsachdevch avatar sroberts2 avatar svarallo avatar toriwilliamsch avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.