AWRS Lookup
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 |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent