reference-data-repository

Boiler Plate for Reference Data Management

A simple application that supports APIs for retrieving reference data categories and codes.

Dependences:

  1. NodeJS 4 or higher
  2. MongoDB 3.2 or higher (uses a DB name of 'refDataRepo')

Data Model:

Category
  id: String,
  category: String,
  version: String,
  description: String,
  parentCategory: String

Codes (category codes)
  id: String,
  category: String,
  version: String,
  parentCode: String,
  canonicalCode: String,
  description: String,
  system1Code: String,
  system2Code: String

Use Cases:

1. Get list of all categories and category versions: http://localhost:3000/api/categories/
2. Get detailed document of a reference data category: http://localhost:3000/api/categories/CountryCode
3. Get detailed document of a reference data category and version: http://localhost:3000/api/categories/CountryCode?categoryVersion=v1
4. Get all codes for a given category and version: http://localhost:3000/api/categories/CountryCode/codes
5. Get all codes that are filtered by parentCode: http://localhost:3000/api/categories/State/codes?parentCode=AU
6. Get detail of code document for a canonical code: http://localhost:3000/api/categories/CountryCode/codes/CA
7. Get system code for given canonical code: <a href="http://localhost:3000/api/categories/CountryCode/codes/CA?fields=system1Code>http://localhost:3000/api/categories/CountryCode/codes/CA?fields=system1Code
8. Get canonical code for a given system code: http://localhost:3000/api/categories/CountryCode/codes/CAN?sourceCodeTypeQualifer=system1Code&amp;fields=canonicalCode

READ ME is still a work in progress