Git Product home page Git Product logo

hmrc.awrs-lookup's Introduction

AWRS Lookup

Build Status Download

This service allows queries to be run against AWRS registrations submitted to ETMP.

License

This code is open source software licensed under the Apache 2.0 License.

Requirements

This service is written in Scala and Play, so needs at least a [JRE] to run.

List of APIs

PATH Supported Methods Description
/awrs-lookup/query/urn/:awrsRef GET Calls ETMP to lookup by awrs reference number
/awrs-lookup/query/name/:queryString GET Calls ETMP to lookup by name

where,

Parameter Description Valid values Example
awrsRef the awrs reference number of an organisation or individual string XXAW00000123462
queryString the name of an organisation or individual string Bricks%20Ltd

and possible responses are:-

Response code Message
200 OK
404 Not Found
400 Bad request
503 Service unavailable
500 Internal server error

Sample response

{ 
   "results":[ 
      { 
         "class":"Business",
         "data":{  
            "awrsRef":"XXAW00000123462",
            "registrationDate":"15 April 2018",
            "status":"04",
            "info":{  
               "businessName":"Company Name",
               "tradingName":"Trading Name",
               "address":{  
                  "addressLine1":"23 Xxxx Street",
                  "addressLine2":"Yyyyyyyy",
                  "addressLine3":"Gloucester",
                  "addressLine4":"Gloucestershire",
                  "postcode":"XX9 1XX"
               }
            }
         }
      }
   ]
}

Examples

Method URI
GET /awrs-lookup/query/urn/XXAW00000123462
GET /awrs-lookup/query/name/Bricks%20Ltd

hmrc.awrs-lookup's People

Contributors

joelturner79 avatar suyangyu avatar paulanderson1234 avatar nikhilbharti avatar jassalrichy avatar versatil56 avatar jameshforster avatar jmountain-hmrc avatar hmrc-web-operations avatar grantrobson avatar kerryannekane avatar davidmthornton avatar ufuoma-daniel avatar thenickwilson avatar danewatts avatar andrewarkless avatar eulogiogutierrez avatar keertigottamhmrc avatar narsiagaram avatar pankaj2453 avatar paulcdurham avatar scott-goodwin avatar shaju-11 avatar tomasz-rosiek avatar jpatton638 avatar nadinj avatar shane-wilson 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.