customs-data-store

This repository contains the code for a persistent cache holding customs related data.

GET /eori/:eori/verified-email

An endpoint to retrieve a verified email address for a given EORI

Response body

{
  "address" : "[email protected]",
  "timestamp" : "2020-03-20T01:02:03Z"
}

Response codes

POST /update-email

An endpoint to update the verified email address for a given EORI

Example request

{
  "eori" : "GB333186811511",
  "address" : "[email protected]",
  "timestamp" : "2020-03-20T01:02:03Z"
}

Fields

GET /eori/:eori/eori-history

An endpoint that provides a list of all historic EORI's associated with a given EORI

Response body

{
"eoriHistory": [
  {
    "eori": "GB333186811511", 
    "validFrom": "2001-01-20T00:00:00Z", 
    "validTo": "2001-01-20T00:00:00Z"
  },
  {
    "eori": "GB333186811531",
    "validFrom": "2001-01-20T00:00:00Z",
    "validTo": "2001-01-20T00:00:00Z"
  }
]
}

Response codes

POST /update-eori-history

An endpoint to populate the historic EORI's for a given EORI

Example request

{
  "eori" : "GB333186811511"
}

Response codes

Running and testing on localhost:

If you want to run customs-data-store locally then you also have to run customs-financials-hods-stub so that it can retrieve historic Eoris from there.
To start the service from sbt: sbt "run 9893" or from service manager: sm --start CUSTOMS_DATA_STORE CUSTOMS_FINANCIALS_HODS_STUB -f
In Postman

1. Send in any of above requests to http://localhost:9893/customs-data-store/
2. Add and Authorization header and set it's value to whatever is in application.conf under the key server-token

License

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