Skip to end of banner
Go to start of banner

Potential personal data in mod-organizations-storage

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

This list of FOLIO attributes that could potentially be considered personal data are contained in the module mod-organizations-storage. Many of these attributes are references by the modules agreements and licenses.

https://dev.folio.org/reference/api/#mod-organizations-storage

mod-organizations-storage/contact.raml

attribute

anonym.

descriptionexampleformat
idY
The unique id of this contact
"08e0eb27-b57f-4638-a703-9a2c57bd8708"
string
prefixY
The prefix for this contact person
"Director"
string
firstNameY
The first name of this contact person
"Nick"
string
lastNameY
The last name of this contact person
"Fury"
string
languageY
The preferred language for this contact person
"en-us"
string
notesY
The notes for this contact person
"SHIELD's Big Kahuna"
string
phoneNumbersY
The list of phone numbers for this contact person
{ "phoneNumber": "19789999999",
         "categories": [
             "0e3f9680-ab06-4565-af64-609b7364e6eb",
             "996ecd31-7ca4-4d8d-9bbf-bc94dff5f6c6"
         ],
         "language": "en-us",
         "type": "Office",
         "isPrimary": true }
"array",
      "items": {
        "type": "object",
        "$ref": "phone_number.json"
      }
emailAddresses
Y
The list of emails for this contact person
{
            "email": {
                "value": "noreply@folio.org",
                "description": "Main"
            },
            "categories": [
                "112ae2e4-88ae-4fa5-a75b-2379d2035e52",
                "56288fe8-8037-44da-8395-01d2d106dc54"
            ],
            "language": "en-us"
        }
"array",
      "items": {
        "type": "object",
        "$ref": "email.json"
      }
adressesY
The list of addresses for this contact person
 {
            "address": {
                "addressLine1": "10 Estes Street",
                "addressLine2": "",
                "city": "Ipswich",
                "stateRegion": "MA",
                "zipCode": "01938",
                "country": "USA"
            },
            "categories": [
                "0e3f9680-ab06-4565-af64-609b7364e6eb",
                "996ecd31-7ca4-4d8d-9bbf-bc94dff5f6c6",
                "112ae2e4-88ae-4fa5-a75b-2379d2035e52",
                "56288fe8-8037-44da-8395-01d2d106dc54"
            ],
            "language": "en"
        }
"array",
      "items": {
        "type": "object",
        "$ref": "address.json"
      }
urlsY
The list of URLs for this contact person
 {
            "url": {
                "value": "http://folio.org",
                "description": ""
            },
            "language": "en-us",
            "categories": [
                "112ae2e4-88ae-4fa5-a75b-2379d2035e52",
                "56288fe8-8037-44da-8395-01d2d106dc54"
            ],
            "notes": ""
        }
"array",
      "items": {
        "type": "object",
        "$ref": "url.json"
      }
contactCategory

The list of contact categories associated with this organization contact person
 [
        "08e0eb27-b57f-4638-a703-9a2c57bd8708",
        "a5da9c44-6619-403f-bd3b-f9bd2f63bc59",
        "da0272e4-7ff7-4ea8-9bc9-9d9cd5c81580",
        "ab18897b-0e40-4f31-896b-9c9adc979a88"
    ]
"array",
      "items": {
        "description": "UUID of the contact category",
        "type": "string"
      }
inactive
Used to indicate that a contact is no longer active
falseboolean
metadata


 {
                "createdDate": "2018-05-19T00:00:00.000+0000",
                "createdByUserId": "16d1157c-d137-11e8-a8d5-f2801f1b9fd1"
            }
"object",
      "$ref": "../../../raml-util/schemas/metadata.schema"

mod-organizations-storage/email.raml

attributeanonym.descriptionexampleformat
idY
The unique id of this email
"588b5c42-8634-4af7-bc9b-5e0116ed96b6"
string                  
valueY
The value for this email
"noreply@folio.org"
string
description
The description for this email
"Main"
string
isPrimary

Used to set this email as primary for the contact

trueboolean
categories
The list of categories for this organization email

"array",
      "items": {
        "type": "string"
      }
languageY
The language for this organization email
"en-us"string
metadata

 {
        "createdDate": "2019-05-19T00:00:00.000+0000",
        "createdByUserId": "16d2357c-d137-11e8-a8d5-f2801f1b9fd1"
    }
"object",
      "$ref": "../../../raml-util/schemas/metadata.schema"

mod-organizations-storage/phone_number.raml

attribute
descriptionexampleformat
idY
UUID
"588b5c42-8634-4af7-bc9b-5e0116ed96b6"
string                  
phoneNumberY
The entire sequence of digits for this phone number
"19789999999"
string
categories
The list of categories for this organization phone
[
        "0e3f9680-ab06-4565-af64-609b7364e6eb",
        "996ecd31-7ca4-4d8d-9bbf-bc94dff5f6c6"
     ]
"array",
      "items": {
        "type": "string"
      }
type
The type of this phone number
"Office"
"string",
       "enum": [
         "Office",
         "Mobile",
         "Fax",
         "Other"
      ]
isPrimary
Used to set this phone number as primary for the contact
trueboolean
languageY
The language for this organization phone
"en-us"
string
metadata

{ "createdDate": "2019-06-08T00:00:00.000+0000", "createdByUserId": "12d2457c-d137-11e8-a8d5-f2802f1b9fd1" }
"object",
      "$ref": "../../../raml-util/schemas/metadata.schema"


mod-organizations-storage/address.raml

attribute
descriptionexampleformat
idY
UUID
"588b5c42-8634-4af7-bc9b-5e0116ed96b6"
string                  
addressLine1Y
The first line of this address
"10 Estes Street"
string
addressLine2Y
The second line of this address

string
cityY
The city for this address
"Ipswich"
string
stateRegionY
The state or region for this address
"MA"
string
zipCodeY
The zip code for this address
"01938"
string
countryY
The country for this address
"USA"string
isPrimary
Used to set this address as primary for the contact

boolean
categories



languageY
The language for this organization address
"en-us"string
metadata

{
                  "createdDate": "2019-06-19T00:00:00.000+0000",
                  "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
            }


mod-organizations-storage/category.raml

attributedescriptionexampleformat
id
The unique id of this category

"08e0eb27-b57f-4638-a703-9a2c57bd8708"

string                  
value
The value of this category

"Accounting"

other examples: "Books", "Customer Service", "Ebooks"

string
metadata
{
          "createdDate": "2018-05-19T00:00:00.000+0000",
          "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
      }
"object",
      "$ref": "../../../raml-util/schemas/metadata.schema",

mod-organizations-storage/url.raml

attributedescriptionexampleformat
id
The unique id of this url
"588b5c42-8634-4af7-bc9b-5e0116ed96b6"
string                  
value
The value for this URL
"http://folio.org"
string
description
The description for this URL
""string
language
The language for this organization URL
"en-us"string
isPrimary
Used to set this url as primary for the contact
trueboolean
categories
The list of categories for this organization URL

"array",
      "items": {
        "type": "string"
      }
notes
The notes for this organization URL

string
metadata
{
                "createdDate": "2019-06-08T00:00:00.000+0000",
                "createdByUserId": "12d2457c-d137-11e8-a8d5-f2802f1b9fd1"
            }
"object",
      "$ref": "../../../raml-util/schemas/metadata.schema"
  • No labels