20766 add alternate_name (#161)

bcgov · Apr 19, 2024 · 4e7a7de · 4e7a7de
1 parent 0255a82
commit 4e7a7de
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 1 deletion.
diff --git a/src/registry_schemas/example_data/schema_data.py b/src/registry_schemas/example_data/schema_data.py
@@ -37,6 +37,7 @@
             'lastLedgerTimestamp': '2019-04-15T20:05:49.068272+00:00',
             'lastPreBobFilingTimestamp': '2019-04-15T20:05:49.068272+00:00',
             'legalName': 'legal name - CP1234567',
+            'alternateNames': [],
             'legalType': 'CP'
         }
     }
@@ -49,6 +50,7 @@
     'lastLedgerTimestamp': '2019-04-15T20:05:49.068272+00:00',
     'lastPreBobFilingTimestamp': '2019-04-15T20:05:49.068272+00:00',
     'legalName': 'legal name - CP1234567',
+    'alternateNames': [],
     'legalType': 'CP',
     'state': 'ACTIVE',
     'goodStanding': True,

diff --git a/src/registry_schemas/schemas/business.json b/src/registry_schemas/schemas/business.json
@@ -72,6 +72,50 @@
         "XS"
       ]
     },
+    "alternateName": {
+      "type": "object",
+      "properties": {
+        "entityType": {
+          "$ref": "#/definitions/legalType"
+        },
+        "identifier": {
+          "$ref": "#/definitions/identifier"
+        },
+        "name": {
+          "type": "string",
+          "title": "The alternate name of the business.",
+          "default": "",
+          "examples": ["alternate_name_of_business"],
+          "pattern": "^(.*)$"
+        },
+        "nameRegisteredDate": {
+          "type": "string",
+          "format": "date-time",
+          "title": "The timestamp of the registered date.",
+          "default": "",
+          "examples": ["1970-01-01T00:00:00+00:00"]
+        },
+        "nameStartDate": {
+          "type": "string",
+          "format": "date",
+          "title": "The start date of the alternate name",
+          "default": "",
+          "examples": ["1970-01-01"]
+        },
+        "nameEndDate": {
+          "type": "string",
+          "format": "date",
+          "title": "The end date of the alternate name",
+          "default": "",
+          "examples": ["1970-01-01"]
+        },
+        "nameType": {
+          "type": "string",
+          "title": "The type of the alternate name",
+          "enum": ["TRANSLATION", "DBA"]
+        }
+      }
+    },
     "warning": {
       "type": "object",
       "properties": {
@@ -154,6 +198,12 @@
         "legalType": {
           "$ref": "#/definitions/legalType"
         },
+        "alternateNames": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/alternateName"
+          }
+        },
         "taxId": {
           "type": "string",
           "title": "The Tax_id Schema",

diff --git a/src/registry_schemas/version.py b/src/registry_schemas/version.py
@@ -23,4 +23,4 @@
 """
 
 
-__version__ = '2.18.23'  # pylint: disable=invalid-name
+__version__ = '2.18.24'  # pylint: disable=invalid-name