Merge branch 'MODTLR-64' of github.com:folio-org/mod-tlr into MODTLR-…

…77_MODTLR-64
folio-org · Nov 16, 2024 · f63157d · f63157d
2 parents 8a52312 + f42d9c5
commit f63157d
Showing 1 changed file with 147 additions and 0 deletions.
diff --git a/src/main/resources/swagger.api/schemas/user.json b/src/main/resources/swagger.api/schemas/user.json
@@ -13,6 +13,10 @@
       "description" : "A globally unique (UUID) identifier for the user",
       "type": "string"
     },
+    "externalSystemId": {
+      "description": "A unique ID that corresponds to an external authority",
+      "type": "string"
+    },
     "barcode": {
       "description": "The unique library barcode for this user",
       "type": "string"
@@ -30,6 +34,26 @@
       "type": "string",
       "$ref": "uuid.json"
     },
+    "departments": {
+      "description": "A list of UUIDs corresponding to the departments the user belongs to, see /departments API",
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "$ref": "uuid.json"
+      }
+    },
+    "meta": {
+      "description": "Deprecated",
+      "type": "object"
+    },
+    "proxyFor": {
+      "description" : "Deprecated",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
     "personal": {
       "description": "Personal information about the user",
       "type": "object",
@@ -45,11 +69,134 @@
         "middleName": {
           "description": "The user's middle name (if any)",
           "type": "string"
+        },
+        "preferredFirstName": {
+          "description": "The user's preferred name",
+          "type": "string"
+        },
+        "email": {
+          "description": "The user's email address",
+          "type": "string"
+        },
+        "phone": {
+          "description": "The user's primary phone number",
+          "type": "string"
+        },
+        "mobilePhone": {
+          "description": "The user's mobile phone number",
+          "type": "string"
+        },
+        "dateOfBirth": {
+          "type": "string",
+          "description": "The user's birth date",
+          "format": "date-time"
+        },
+        "addresses": {
+          "description": "Physical addresses associated with the user",
+          "type": "array",
+          "minItems": 0,
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "description": "A unique id for this address",
+                "type": "string"
+              },
+              "countryId": {
+                "description": "The country code for this address",
+                "type": "string"
+              },
+              "addressLine1": {
+                "description": "Address, Line 1",
+                "type": "string"
+              },
+              "addressLine2": {
+                "description": "Address, Line 2",
+                "type": "string"
+              },
+              "city": {
+                "description": "City name",
+                "type": "string"
+              },
+              "region": {
+                "description": "Region",
+                "type": "string"
+              },
+              "postalCode": {
+                "description": "Postal Code",
+                "type": "string"
+              },
+              "addressTypeId": {
+                "description": "A UUID that corresponds with an address type object",
+                "type": "string",
+                "$ref": "uuid.json"
+              },
+              "primaryAddress": {
+                "description": "Is this the user's primary address?",
+                "type": "boolean"
+              }
+            },
+            "required":[
+              "addressTypeId"
+            ],
+          }
+        },
+        "preferredContactTypeId": {
+          "description": "Id of user's preferred contact type like Email, Mail or Text Message, see /addresstypes API",
+          "type": "string"
+        },
+        "profilePictureLink": {
+          "description": "Link to the profile picture",
+          "type": "string",
+          "format": "uri"
         }
       },
       "required": [
         "lastName"
       ]
+    },
+    "enrollmentDate": {
+      "description": "The date in which the user joined the organization",
+      "type": "string",
+      "format": "date-time"
+    },
+    "expirationDate": {
+      "description": "The date for when the user becomes inactive",
+      "type": "string",
+      "format": "date-time"
+    },
+    "createdDate": {
+      "description": "Deprecated",
+      "type": "string",
+      "format": "date-time"
+    },
+    "updatedDate": {
+      "description": "Deprecated",
+      "type": "string",
+      "format": "date-time"
+    },
+    "metadata": {
+      "type": "object",
+      "$ref": "uuid.json"
+    },
+    "tags": {
+      "type": "object",
+      "$ref": "uuid.json"
+    },
+    "customFields" : {
+      "description": "Object that contains custom field",
+      "type": "object",
+      "additionalProperties": true
+    },
+    "preferredEmailCommunication": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["Support", "Programs", "Services"]
+      },
+      "maxItems": 3,
+      "uniqueItems": true,
+      "description": "Preferred email communication types"
     }
   }
 }