Person¶
A Person
objects represents a web resource about a person. For example, this could be a composer or performer.
We recommend that the following fields are set:
field |
required |
Description |
---|---|---|
yes |
The title of the resource indicated by |
|
contributor |
yes |
The main URL of the site where the information about this Person was taken from |
creator |
yes |
The person, organization or service who is creating this Person (e.g. URL of the software) |
source |
yes |
The URL of the web resource where information about this Person is taken from |
language |
yes |
The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr |
format_ |
yes |
The mimetype of the resource indicated by source |
name |
yes |
The name of the person |
family_name |
The family name of the person |
|
given_name |
The given name of the person |
|
gender |
The person’s gender |
|
birth_date |
The birth date of the person, formatted as yyyy, yyyy-mm or yyyy-mm-dd |
|
death_date |
The date of death of the person , formatted as yyyy, yyyy-mm or yyyy-mm-dd |
|
description |
A biographical description of the person |
|
image |
URL to an image associated with the person |
|
publisher |
An entity responsible for making the resource available |
|
honorific_prefix |
An honorific prefix |
|
honorific_suffix |
An honorific suffix |
|
job_title |
The person’s job title |
Relations¶
exactMatch: Use trompace.mutations.person.mutation_person_add_exact_match_person()
-
trompace.mutations.person.
mutation_create_person
(*, title: str, contributor: str, creator: str, source: str, format_: str, language: str = None, name: str = None, family_name: str = None, given_name: str = None, gender: str = None, birth_date: str = None, death_date: str = None, description: str = None, image: str = None, publisher: str = None, honorific_prefix: str = None, honorific_suffix: str = None, job_title: str = None)¶ Returns a mutation for creating a Person
- Parameters
title – The title of the resource indicated by source
contributor – The main URL of the site where the information about this Person was taken from
creator – The person, organization or service who is creating this Person (e.g. URL of the software)
source – The URL of the web resource where information about this Person is taken from
language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr
format_ – The mimetype of the resource indicated by source
name – The name of the person
family_name (optional) – The family name of the person
given_name (optional) – The given name of the person
gender (optional) – The person’s gender
birth_date (optional) – The birth date of the person, formatted as yyyy, yyyy-mm or yyyy-mm-dd
death_date (optional) – The date of death of the person , formatted as yyyy, yyyy-mm or yyyy-mm-dd
description (optional) – A biographical description of the person
image (optional) – URL to an image associated with the person
publisher (optional) – An entity responsible for making the resource available
honorific_prefix (optional) – An honorific prefix.
honorific_suffix (optional) – An honorific suffix.
job_title (optional) – The person’s job title.
- Returns
The string for the mutation for creating the person.
- Raises
UnsupportedLanguageException – if
language
is not one of the supported languages.ValueError – if
gender
is not a value supported by the CENotAMimeTypeException – if
format_
is not a valid mimetype.
-
trompace.mutations.person.
mutation_delete_person
(identifier: str)¶ Returns a mutation for deleting a Person with the given identifier.
- Parameters
identifier – The identifier of the Person to delete.
- Returns
A mutation string to delete a Person
-
trompace.mutations.person.
mutation_person_add_exact_match_person
(identifier_from: str, identifier_to: str)¶ Returns a mutation for linking two Person objects with skos:exactMatch.
- Parameters
identifier_from – the identifer of the Person to match to
identifier_to – the identifier of the Person that is an exact match of identifier_from
Returns: a mutation to make an exactMatch relationship between the Person objects
-
trompace.mutations.person.
mutation_person_remove_exact_match_person
(identifier_from: str, identifier_to: str)¶ Returns a mutation for removing the skos:exactMatch relation between two Person objects
- Parameters
identifier_from – the identifer of the Person to match to
identifier_to – the identifier of the Person that is an exact match of identifier_from
Returns: a mutation to remove the exactMatch relationship from the Person objects
-
trompace.mutations.person.
mutation_update_person
(identifier: str, *, title: str = None, contributor: str = None, creator: str = None, source: str = None, language: str = None, format_: str = None, name: str = None, family_name: str = None, given_name: str = None, gender: str = None, birth_date: str = None, death_date: str = None, description: str = None, image: str = None, publisher: str = None, honorific_prefix: str = None, honorific_suffix: str = None, job_title: str = None)¶ Returns a mutation for updating a Person
- Parameters
identifier – The identifier of the person in the CE to be updated
title – The title of the resource indicated by source
contributor – The main URL of the site where the information about this Person was taken from
creator – The person, organization or service who is creating this Person (e.g. URL of the software)
source – The URL of the web resource where information about this Person is taken from
language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr
format_ – The mimetype of the resource indicated by source
name – The name of the person
family_name (optional) – The family name of the person
given_name (optional) – The given name of the person
gender (optional) – The person’s gender
birth_date (optional) – The birth date of the person, formatted as yyyy, yyyy-mm or yyyy-mm-dd
death_date (optional) – The date of death of the person , formatted as yyyy, yyyy-mm or yyyy-mm-dd
description (optional) – A biographical description of the person
image (optional) – URL to an image associated with the person
publisher (optional) – An entity responsible for making the resource available
honorific_prefix (optional) – An honorific prefix.
honorific_suffix (optional) – An honorific suffix.
job_title (optional) – The person’s job title.
- Returns
The string for the mutation for updating the person.
- Raises
UnsupportedLanguageException – if
language
is not one of the supported languages.ValueError – if
gender
is not a value supported by the CeNotAMimeTypeException – if
format_
is not a valid mimetype.