Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

attributedescriptionexampleformat
id
The unique id of this contact
"08e0eb27-b57f-4638-a703-9a2c57bd8708"
string
prefix
The prefix for this contact person
"Director"
string
firstName
The first name of this contact person
"Nick"
string
lastName
The last name of this contact person
"Fury"
string
language
The preferred language for this contact person
"en-us"
string
notes
The notes for this contact person
"SHIELD's Big Kahuna"
string
phoneNumbers
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
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"
      }
adresses
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"
      }
urls
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"

...

attributedescriptionexampleformat
id
UUID
"588b5c42-8634-4af7-bc9b-5e0116ed96b6"
string                  
phoneNumber
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
language
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"

...