...
mod-organizations-storage/phone_number.raml
| attribute | anonym. | description | example | format |
|---|
| id | Y | UUID
| "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
| string |
| phoneNumber | Y | 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
| true | boolean |
| language | Y | 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 | anonym. | description | example | format |
|---|
| id | YN | UUID
| "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
| string |
| addressLine1 | YN | The first line of this address
| "10 Estes Street"
| string |
| addressLine2 | YN | The second line of this address
|
| string |
| city | YN | The city for this address
| "Ipswich"
| string |
| stateRegion | YN | The state or region for this address
| "MA"
| string |
| zipCode | YN | The zip code for this address
| "01938"
| string |
| country | YN | The country for this address
| "USA" | string |
| isPrimary | N | Used to set this address as primary for the contact
|
| boolean |
| categories | N |
|
|
|
| language | YN | The language for this organization address
| "en-us" | string |
| metadata | N |
| {
"createdDate": "2019-06-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
|
|
...
mod-organizations-storage/category.raml
| attribute | anonym. | description | example | format |
|---|
| 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
| attribute | anonym. | description | example | format |
|---|
| id | N | The unique id of this url
| "588b5c42-8634-4af7-bc9b-5e0116ed96b6"
| string |
| value | N | The value for this URL
| "http://folio.org"
| string |
| description | N | The description for this URL
| "" | string |
| language | N | The language for this organization URL
| "en-us" | string |
| isPrimary |
| Used to set this url as primary for the contact
| true | boolean |
| categories |
| The list of categories for this organization URL
|
| "array",
"items": {
"type": "string"
}
|
| notes | N | 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"
|
...