Skip to content

Commit 09afe23

Browse files
committed
include optional patron address field (#29)
1 parent 378492a commit 09afe23

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

paia.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -485,16 +485,18 @@ scope
485485
: read_patron
486486
response fields
487487
: name occ data type description
488-
--------- ------ --------------- ------------------------------
488+
--------- ------ --------------- ---------------------------------
489489
name 1..1 string full name of the patron
490490
email 0..1 email email address of the patron
491+
address 0..1 string freeform address of the patron
491492
expires 0..1 datetime patron account expiry
492493
status 0..1 account state current state (0, 1, 2, or 3)
493-
--------- ------ --------------- -------------------------------
494+
--------- ------ --------------- --------------------------------
494495
mapping to RDF
495496
: see [patrons in RDF]
496497

497-
Additional fields such as address may be added in a later revision.
498+
Application SHOULD refer to a specialized API, such as LDAP, to get more
499+
detailed patron information.
498500

499501
**Example**
500502

@@ -517,6 +519,7 @@ X-OAuth-Scopes: read_fees read_items read_patron write_items
517519
{
518520
"name": "Jane Q. Public",
519521
"email": "[email protected]",
522+
"address": "Park Street 2, Springfield",
520523
"expires": "2015-05-18",
521524
"status": 0
522525
}
@@ -947,7 +950,10 @@ with [particip:endDate]. The patron identifier is given with
947950

948951
A patron account belongs to a person or another [foaf:Agent], connected to with
949952
[sioc:account_of] and [foaf:account]. The full name of a patron is given with
950-
[foaf:name] and its email address can be given with [foaf:mbox].
953+
[foaf:name] and its email address can be given with [foaf:mbox]. The address
954+
field SHOULD NOT be mapped to RDF properties such as [schema:address] and
955+
[vcard:hasAddress] which expect a structured object instead of a plain literal
956+
value. The generic property [dbp:address] can be used instead.
951957

952958
~~~ {.ttl}
953959
@prefix sioc: <http://rdfs.org/sioc/ns#> .
@@ -963,16 +969,19 @@ paia:PatronAccount a owl:Class ;
963969
foaf:name, foaf:mbox .
964970
~~~
965971

972+
[dbp:address]: http://live.dbpedia.org/property/address
966973
[foaf:AccountName]: http://xmlns.com/foaf/0.1/AccountName
967-
[sioc:User]: http://rdfs.org/sioc/ns#User
968-
[sioc:account_of]: http://rdfs.org/sioc/ns#account_of
969-
[foaf:OnlineAccount]: http://xmlns.com/foaf/0.1/OnlineAccount
970974
[foaf:Agent]: http://xmlns.com/foaf/0.1/Agent
975+
[foaf:OnlineAccount]: http://xmlns.com/foaf/0.1/OnlineAccount
971976
[foaf:account]: http://xmlns.com/foaf/0.1/account
972-
[foaf:name]: http://xmlns.com/foaf/0.1/name
973977
[foaf:mbox]: http://xmlns.com/foaf/0.1/mbox
974-
[particip:endDate]: http://purl.org/vocab/participation/schema#endDate
978+
[foaf:name]: http://xmlns.com/foaf/0.1/name
975979
[particip:Role]: http://purl.org/vocab/participation/schema#Role
980+
[particip:endDate]: http://purl.org/vocab/participation/schema#endDate
981+
[schema:address]: http://schema.org/address
982+
[sioc:User]: http://rdfs.org/sioc/ns#User
983+
[sioc:account_of]: http://rdfs.org/sioc/ns#account_of
984+
[vcard:hasAddress]: www.w3.org/TR/vcard-rdf/
976985

977986
An instance of paia:patronAccount is assumed to be active, unless it is also
978987
an instance of **paia:InactivePatronAccount**.

0 commit comments

Comments
 (0)