Skip to main content

4.67. ETL - Retrieve addresses

Id 4.67.
Description

As an ETL user,

 

I must be able to read all address information present in the NRVC address database, 

 

So that I can determine the changes that need to be performed on the address database to synchronise it with the external Address Data Providers
Priority High
Actors ETL
API Calls

GET /addresses

GET /addresses/<address-id>
Linked Processes
Status Implemented

Preconditions

  1. The User must be authenticated and have the ETL role.
  2. The user must have an address to be looked up on the system (id or filter / search criteria)

Postconditions

  1. The System returns the data that matches the request.

Main flow

  1. The ETL user triggers an address request (GET) by id or using search/filter criteria.
  2. The system returns the addresses that match the query.

Exceptions

[400 Bad Request] Invalid input:

If mandatory fields are missing or invalid, the system returns an error message.

[404 Not Found] Address not found:

Error returned if the Server could not find any address for the given search criteria.

[500 Internal Server Error] System Error

If the system fails to save changes due to an internal error, it displays an appropriate message and logs the error for further investigation.

No comments to display

Back to top