-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create hierarchy of Contact information (#8)
- Loading branch information
Showing
13 changed files
with
176 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Electronic Address | ||
|
||
## Definition | ||
An electronic address assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Specialization of | ||
[Contact Information](../datatypes/Contact_Information.md) | ||
|
||
## Note | ||
An electronic address might be [Email address](../datatypes/Email_Address.md), [Telephone number](../datatypes/Telephone_Number.md), [Website URL](../datatypes/Website_Address.md). | ||
Moreover, additional subtypes of Electronic Address can be created in CERIF modules. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Email Address | ||
|
||
## Definition | ||
An email address assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Specialization of | ||
[Electronic Address](../datatypes/Electronic_Address.md) | ||
|
||
## Based on | ||
[URI](../datatypes/URI.md) | ||
|
||
## Restrictions | ||
1. The URI must start with `mailto:` | ||
2. The rest of the URI must match the regular expression<sup>[1](#fn1)</sup>: `^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$` | ||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org Email](https://schema.org/email) | ||
|
||
## References | ||
<a name="fn1">\[1\]</a> Email address validation https://regexr.com/3e48o |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Phone Number | ||
|
||
## Definition | ||
A phone number assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Specialization of | ||
[Electronic Address](../datatypes/Electronic_Address.md) | ||
|
||
## Based on | ||
[URI](../datatypes/URI.md) | ||
|
||
## Restrictions | ||
1. The URI must match RFC 3966 specification <sup>[1](#fn1)</sup> | ||
|
||
## Examples | ||
- `tel:+1-201-555-0123` - This URI points to a full phone number. | ||
- `tel:863-1234;phone-context=+1-914-555` - The URI describes a local | ||
phone number that is valid within a particular phone prefix. | ||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org Phone](https://schema.org/telephone) | ||
|
||
## References | ||
<a name="fn1">\[1\]</a> The tel URI for Telephone Numbers https://datatracker.ietf.org/doc/html/rfc3966 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Physical Address | ||
|
||
## Definition | ||
The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md) or some other CERIF entity instance. | ||
|
||
## Notes | ||
Please note there are two specializations of this data type providing more or less structured details about a physical | ||
address [Simple Physical Address](../datatypes/Simple_Physical_Address.md) and [Structured Physical Address](../datatypes/Structured_Physical_Address.md) | ||
|
||
## Components | ||
- country : [Country](../datatypes/Country.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,15 @@ | ||
# Postal Address | ||
|
||
## Definition | ||
The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md) or some other CERIF entity instance. | ||
A postal address assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Notes | ||
Please note there are two specializations of this data type providing more or less structured details about a postal | ||
address [Simple Postal Address](../datatypes/Simple_Postal_Address.md) and [Structured Postal Address](../datatypes/Structured_Postal_Address.md) | ||
## Specialization of | ||
[Contact Information](../datatypes/Contact_Information.md) | ||
|
||
## Components | ||
- country : [Country](../datatypes/Country.md) | ||
- physical address : [Physical Address](../datatypes/Physical_Address.md) | ||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org home location](https://schema.org/homeLocation) | ||
2. Close match of [Schema.org address](https://schema.org/address) |
6 changes: 3 additions & 3 deletions
6
datatypes/Simple_Postal_Address.md → datatypes/Simple_Physical_Address.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
# Simple Postal Address | ||
|
||
## Definition | ||
This data type is used when a string representation of postal address is used. | ||
This data type is used when a string representation of physical address is used. | ||
|
||
## Notes | ||
The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations. | ||
|
||
## Specialization of | ||
[Postal Address](../datatypes/Postal_Address.md) | ||
[Physical Address](../datatypes/Physical_Address.md) | ||
|
||
## Components | ||
- those inherited from [Postal Address](../datatypes/Postal_Address.md#components) | ||
- those inherited from [Physical Address](../datatypes/Physical_Address.md#components) | ||
- address : [Multilingual String](../datatypes/Multilingual_String.md) | ||
|
10 changes: 6 additions & 4 deletions
10
datatypes/Structured_Postal_Address.md → datatypes/Structured_Physical_Address.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,21 @@ | ||
# Structured Postal Address | ||
|
||
## Definition | ||
This data type is used when a structured representation of postal address is used. | ||
This data type is used when a structured representation of physical address is used. | ||
|
||
## Notes | ||
The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations. | ||
|
||
## Specialization of | ||
[Postal Address](../datatypes/Postal_Address.md) | ||
[Physical Address](../datatypes/Physical_Address.md) | ||
|
||
## Components | ||
- those inherited from [Postal Address](../datatypes/Postal_Address.md#components) | ||
- those inherited from [Physical Address](../datatypes/Physical_Address.md#components) | ||
- street : [Multilingual String](../datatypes/Multilingual_String.md) | ||
- city : [Multilingual String](../datatypes/Multilingual_String.md) | ||
- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md) | ||
- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.md) | ||
|
||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org Postal address](https://schema.org/PostalAddress) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Visiting Address | ||
|
||
## Definition | ||
A visiting address assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Specialization of | ||
[Contact Information](../datatypes/Contact_Information.md) | ||
|
||
## Components | ||
- physical address : [Physical Address](../datatypes/Physical_Address.md) | ||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org work location](https://schema.org/workLocation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Website Address | ||
|
||
## Definition | ||
A website address assigned to an [Agent](../entities/Organisation_Unit.md). | ||
|
||
## Specialization of | ||
[Electronic Address](../datatypes/Electronic_Address.md) | ||
|
||
## Based on | ||
[URI](../datatypes/URI.md) | ||
|
||
## Restrictions | ||
1. The URI must match the regular expression<sup>[1](#fn1)</sup>: `[(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)` | ||
|
||
--- | ||
## Matches | ||
1. Close match of [Schema.org URL](https://schema.org/url) | ||
|
||
## References | ||
<a name="fn1">\[1\]</a> URL validation https://regexr.com/39nr7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters